diff options
| -rw-r--r-- | README.md | 38 |
1 files changed, 15 insertions, 23 deletions
@@ -1,13 +1,11 @@ -# RTS (working title) +# `jancity` ## Overview -**RTS** is a cross-platform, sprite-based real-time strategy video game -in the likes of several other entries from the mid 90's. +`jancity` is a cross-platform, tile-based sandbox video game. -**The game is under heavy development, and very far from being playable.** - - +Mostly written during the Global Game Jam 2024 event, reusing its engine +from [`rts`](https://gitea.privatedns.org/xavi/rts). ## Platforms @@ -42,14 +40,12 @@ hardware. ### Native build -A native version of **RTS** can be built using the typical CMake build +A native version of `jancity` can be built using the typical CMake build process: ```sh -mkdir build -cd build -cmake .. -cmake --build . -j$(nproc --all) +cmake -B build +cmake --build build ``` #### Dependencies @@ -57,7 +53,7 @@ cmake --build . -j$(nproc --all) ##### Ubuntu ```sh -apt install libsdl-gfx1.2-dev libsdl-mixer1.2-dev libsdl1.2-dev +apt install libsdl-gfx1.2-dev libsdl-mixer1.2-dev libsdl1.2-dev libenet-dev ``` ### Cross-compilation @@ -71,12 +67,10 @@ can be used to set up the cross-toolchain. Files labeled as For example, the Sony® PlayStation® 1 version can be built using: ```sh -mkdir build -cd build -cmake .. \ - -DCMAKE_TOOLCHAIN_FILE=../cmake/ps1-toolchain.cmake \ +cmake -B build \ + -DCMAKE_TOOLCHAIN_FILE=cmake/ps1-toolchain.cmake \ -DVIDEO_MODE=VMODE_PAL # VMODE_NTSC can be otherwise used -make -j$(nproc --all) +cmake --build build ``` This will generate a `.bin`/`.cue` file pair in `build` that can be @@ -90,14 +84,12 @@ environment variable called `PSXSDK_PATH`. #### Microsoft® Win9x ```sh -mkdir build -cd build SDLDIR=<sdl-prefix> \ SDLMIXERDIR=<sdl_mixer-prefix> \ SDLGFXDIR=<sdl_gfx-prefix> \ ENETDIR=<enet-prefix> \ - cmake .. -DCMAKE_TOOLCHAIN_FILE=../cmake/win9x-toolchain.cmake -make -j$(nproc --all) + cmake -B build -DCMAKE_TOOLCHAIN_FILE=cmake/win9x-toolchain.cmake +cmake --build build ``` Where: @@ -121,7 +113,7 @@ located in `build/cdimg`. #### Dependencies A cross-compiled `i386-mingw32` version of all required dependencies -is needed before building `rts`. +is needed before building `jancity`. Note upstream CMake does not provide `FindSDL_gfx.cmake` as of the time of this writing, so it is provisionally provided on @@ -134,7 +126,7 @@ how to build the dependencies from source. ## License -Unless stated otherwise, **RTS** follows the license described by the +Unless stated otherwise, **jancity** follows the license described by the `LICENSE` file, which currently is the GNU General Public License v3 or later. Original versions of other works under various licenses are also distributed in this project, that are located inside the |