diff options
| -rw-r--r-- | README | 21 |
1 files changed, 12 insertions, 9 deletions
@@ -1,7 +1,6 @@ Hey! This README is for those looking to work on the code. For actual plugin -documentation, you’ll want to look at the website, which currently exists in a -semi-temporary state at https://mikes.software/sst — or ask for help in a -relevant speedrunning community. +documentation, you’ll want to look at the website at https://mikes.software/sst/ +or ask for help in a relevant speedrunning community. NOTE: Please read and understand LICENCE before redistributing this software! @@ -19,13 +18,14 @@ Linux: might be able to compile this too, but Clang is heavily preferred in the name of consistency and using GCC will require a decent amount of fiddling. It’s also not tested and might break and I probably won’t care that much. - • Install 32-bit C libraries and the C library headers if they're not already + • Install 32-bit C libraries and the C library headers if they’re not already installed. • Run ./compile (in lieu of a better build tool, to be added later). -NOTE: Linux builds currently produce a binary that most definitely does not -work, along with a whole host of warnings; there’s a bunch of code that needs to -be written. See also TODO/linux. +NOTE: Linux code doesn’t quite compile yet and even if it did it probably +wouldn’t quite work. Essentially, it’s a placeholder to ensure that supporting +Linux in the future isn’t totally impossible, but there’s still a bunch of code +that would have to be written first. See also TODO/linux. ════ How and where to install ════ @@ -49,8 +49,11 @@ mods in an engine installation, where relevant. It’s additionally possible to back out of the game installation with `../../` etcetera and load from anywhere you want, as long as it’s not on a different -Windows drive letter. This is especially handy if you're building from source -and don't want to copy it over every time. +Windows drive letter. This is especially handy if you’re building from source +and don’t want to copy it over every time. Note: some very old (and very new) Source builds don’t have a plugin_load command. For the time being, these versions are unsupported. + +Thanks, and have fun! +- Michael Smith <mikesmiffy128@gmail.com> |