davejansen/stardew-valley-mods-devcontainer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added Quick Start/TL;DR section to the README.

Browse Source
This commit is contained in:
Dave Jansen
2021-12-06 15:27:46 +09:00
parent e19d698e8b
commit 036de2d8d0
1 changed files with 10 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -4,6 +4,16 @@ A VSCode devcontainer configuration optimized for Stardew Valley mod development
The devcontainer has been configured and should fully support Fedora and any other environment that uses selinux. The devcontainer has been configured and should fully support Fedora and any other environment that uses selinux.
# Quick Start
The TL;DR of below:
- Make sure you have SMAPI for developers installed
- Create a symlink to your Stardew Valley installation directory called `_gamedirref` in the root of your project (`ln -s /path/to/stardew-valley ./_gamedirref`)
- Build and re-open project in dev container
- Build your mod project using the included build script (`ctrl+shift+b` or `cmd+shift+b`)
- Happy coding! :-)
# Prerequisites # Prerequisites
If you are starting with creating a new mod, you can use the "Use this template" option to create a repository under your own account with the prerequisite files in place. From there you can simply set up your Stardew Valley mod project as you usually would. If you are starting with creating a new mod, you can use the "Use this template" option to create a repository under your own account with the prerequisite files in place. From there you can simply set up your Stardew Valley mod project as you usually would.