BaseMod icon indicating copy to clipboard operation
BaseMod copied to clipboard

Docs website

Open alexdriedger opened this issue 6 years ago • 3 comments

Documentation website for modding Slay the Spire, which will be able to be found at https://daviscook477.github.io/Basemod

Features

  • BaseMod wiki is fully moved to the website
  • Key pieces of the ModTheSpire wiki
  • Rewrite of some key docs and getting started page
  • One stop shop to getting started with modding
  • Section for playing with mods (aka people who want to play with mods but not develop them)
  • Built with Docusaurus and published with GitHub Pages

Publishing

I am not able to publish the website since I don't have push access to this repo. The publishing guide can be found here.

To publish the website, I believe you will just need to run the following command once this PR is merged into master

GIT_USER=kiooeht \
  CURRENT_BRANCH=master \
  yarn run publish-gh-pages # or `npm run publish-gh-pages`

ModTheSpire Documentation

I left most of the MTS documentation out here, since it is the BaseMod repo. I did include parts that are very relevant to BaseMod and/or getting started with modding. It would be fairly straightforward to move MTS documentation to this website too, if that is something that you think should be done.

alexdriedger avatar Sep 30 '18 08:09 alexdriedger

Website is live at https://alexdriedger.github.io/SlayTheSpireModding

alexdriedger avatar Oct 11 '18 12:10 alexdriedger

I just updated the baseUrl in, which was probably causing problems if you had tried to publish the site.

If you are on Windows, you will need to set GIT_USER as an environment variable

alexdriedger avatar Oct 15 '18 05:10 alexdriedger

Please make a video about how make a mod on slay the spire because I'm really not getting it so please please make mod for me

CursedWarrior10HD avatar Nov 10 '18 14:11 CursedWarrior10HD