exmods/HelloModdingWorld
1
0
Fork 0
Code Issues Pull requests Releases Activity

Update README to no longer have no-api branch and remove mentions of Gamecraft

Browse source
This commit is contained in:
NGnius (Graham) 2021-04-17 15:22:00 -04:00
parent 3b49d60650
commit 4d49a0c5b8
1 changed files with 11 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
README.md
View file

@ -1,23 +1,25 @@
# HelloModdingWorld
Shell project for Gamecraft mods.
Shell project for Techblox mods.
Use this as a quick-start project structure for your own mods, or to learn how modding works.
## Setup
This project requires most of Gamecraft's `.dll` files to function correctly.
Most, but not all, of these files are stored in Gamecraft's `Gamecraft_Data\Managed` folder.
This project requires most of Techblox's `.dll` files to function correctly.
Most, but not all, of these files are stored in Techblox's `Techblox_Data/Managed` folder.
The project is pre-configured to look in a folder called ref in the solution's main directory or one level up from that.
You can make sure HelloModdingWorld can find all of `.dll` files it needs by copying your Gamecraft folder here and renaming it to `ref`, but you'll have to re-copy it after every Gamecraft update.
You can also create a symbolic link (look it up) to your Gamecraft install folder named `ref` in this folder to avoid having to re-copy files.
You can make sure HelloModdingWorld can find all of `.dll` files it needs by copying your Techblox folder here and renaming it to `ref`, but you'll have to re-copy it after every Techblox update.
You can also create a symbolic link (look it up) to your Techblox install folder named `ref` in this folder to avoid having to re-copy files.
For any mod to work, you will have to patch your game with [GCIPA](https://git.exmods.org/modtainers/GCIPA).
[Direct link to install guide](https://git.exmods.org/modtainers/GCIPA/src/branch/master/README.md#how-to-install).
!!Download a release from git.exmods.org not github.com!!
This project also requires the [GamecraftModdingAPI](https://git.exmods.org/modtainers/GamecraftModdingAPI) library to be installed (in `ref/Plugins/GamecraftModdingAPI.dll`).
[Direct link to install guide](https://www.exmods.org/guides/install.html).
[Direct link to install guide](https://www.exmods.org/guides/install.html).
If you don't want to use the standard modding API,
you can remove the dependency by removing `<Reference Include="GamecraftModdingAPI"> ... </Reference>` in `HelloModdingWorld.csproj` and removing all mentions in `MyPlugin.cs`.
## Building
@ -25,8 +27,9 @@ After you've completed the setup, open the solution file `HelloModdingWorld.sln`
I'd recommend Visual Studio Community Edition or JetBrains Rider for Windows and Monodevelop for Linux.
If you've successfully completed setup, you should be able to build the HelloModdingWorld project without errors.
The build configuration should be automatically imported from the project's files.
If it doesn't work and you can't figure out why, ask for help on [our Discord server](https://discord.gg/xjnFxQV).
## Installation
To install the HelloModdingWorld mod, copy the build's `HelloModdingWorld.dll` into the `Plugins` folder in Gamecraft's main folder.
To install the HelloModdingWorld mod, copy the build's `HelloModdingWorld.dll` into the `Plugins` folder in Techblox's main folder.