/soloscuro-archive

A Dark Sun Engine

Primary LanguageCMIT LicenseMIT

Sol Oscuro

A Dark Sun Engine

Goals: To create an engine for Dark Sun 1, 2, and Crimson Sands.

Discord

https://discord.gg/W942xHN72S

How to run

Sol Oscuro requires the .gff files from DarkSun 1 Shattered lands to run. Create a directory/folder 'ds1' and put the .GFF files there (you can put the entire game in there if you wish.)

Linux dev setup

  1. install pre-reqs: $ sudo apt install sndfile-tools libsndfile1-dev libsdl2-* lua5.3 liblua5.3-dev cmake

  2. build

        $ make

    This should pull the libadlmidi library and compile everything.

  3. Put your darksun1 gffs into a directory ds1/ inside your repo. You can make a symlink as well.

  4. You can run test:

        $ make test

  5. Right now the engine does not have a solid entry point. You can run a test:

    $ LD_LIBRARY_PATH=lib/ build/mdark --lua lua/test/main.lua Naturally, there are other tests you can view in lua/test/

    You may also load up the gff viewer (browser): $ LD_LIBRARY_PATH=lib/ build/mdark --browse

Windows dev setup with msys2:

You should be able to follow the instructions for gcc with vscode: https://code.visualstudio.com/docs/cpp/config-mingw

Below are the old instructions...

Note: The windows build is currently broken. Please install Bash on Ubuntu on Windows and use the Linux install.

  1. Install msys2 (http://msys2.org) download the installer and run (must be 64-bit.)

  • default C:\msys64 is fine and assumed for these instructions.

  • update pacman:

    $ pacman -Syu

  • Say yes to everything, make sure the window closes, and then open msys2 again.

  • Update pacman's cache:

    $ pacman -Su

  • Close the window and open MSYS2 Mingw 64-bit

    MAKE SURE IT IS THE 64-bit one!!!

  • install all the packages:

    $ pacman -S mingw-w64-x86_64-toolchain git mingw-w64-x86_64-toolchain mingw64/mingw-w64-x86_64-SDL2 mingw64/mingw-w64-x86_64-SDL2_mixer mingw64/mingw-w64-x86_64-SDL2_image mingw64/mingw-w64-x86_64-SDL2_ttf mingw64/mingw-w64-x86_64-SDL2_net mingw64/mingw-w64-x86_64-cmake make git mingw-w64-x86_64-libsndfile

  • The above does take a long time.

  1. clone the soloscuro repository:
  • $ git clone https://github.com/dsoageofheroes/soloscuro.git
  1. To simplify window dev creation, prebuild libs are provided and must be installed.

  • create a libs/ folder in your clone

    $ mkdir libs/

  • Download the pack (http://dso.paulofthewest.com/downloads/soloscuro-win64-dev-pack.zip)

  • FYI: Your clone repos is probably in C:\msys2\home<your username>\soloscuro

  • Create a libs/ folder inside your repository.

  • extract the lib53.dll and ADLMIDI.dll file into libs/

  • Don't forget to create the libs directory and put the dlls in there.

  1. To compile:
  • $ make -f makefile.win mdark
  1. Now copy everything from the 'soloscuro-lib' folder in the previous zip file (http://dso.paulofthewest.com/downloads/soloscuro-win64-dev-pack.zip) into the run folder (which should have only a mdark.exe file in it right now.
  • This should setup all the dlls/so for the game.
  1. To run you will need to create a ds1 folder in run with all the ds1's gffs in it. Now run mdark.exe (inside of the run folder.)