dtdannen / dcss-ai-wrapper

An API for Dungeon Crawl Stone Soup for Artificial Intelligence research.
MIT License
41 stars 13 forks source link

Add instructions for creating sprints #27

Open dtdannen opened 2 years ago

dtdannen commented 2 years ago

The sprints that come with the game are located here: https://github.com/crawl/crawl/tree/master/crawl-ref/source/dat/des/sprint

The custom sprints we've made at various points in time are located here: https://github.com/dtdannen/dcss-ai-wrapper/tree/master/custom_sprints

All you need to do is make a new sprint file in the folder crawl-ref/source/dat/des/sprint/ and then run the webserver.

As an example you can take the hellosprint.des in our custom sprints, rename it to hello_sprint.des (I'm not sure if name matters, it may need to match the name in the file contents itself) and move it into the docker container's ..crawl-ref/source/dat/des/sprint/ folder, then start up the webserver like the normal. I think it should automatically show up at the end of the list in the sprints.

I just tested this myself and got it to work. I need to update the README on the project with these instructions. Great question, thank you for asking!

If you aren't able to get it to work, please let me know. On my docker container, I had to install nano to create a new sprint file.

beeWAtoN commented 2 years ago

Some notes regarding running sprints on local device: