Shell project for Techblox mods
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
NGnius (Graham) 20ca27983c Update refs for Techblox 2022.03.17.17.24 4 months ago
HelloModdingWorld Update refs for Techblox 2022.03.17.17.24 4 months ago
.gitignore Create project 2 years ago
HelloModdingWorld.sln Create project 2 years ago
LICENSE Initial commit 2 years ago
README.md Update README to no longer have no-api branch and remove mentions of Gamecraft 1 year ago

README.md

HelloModdingWorld

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 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 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. Direct link to install guide.

This project also requires the GamecraftModdingAPI library to be installed (in ref/Plugins/GamecraftModdingAPI.dll). Direct link to install guide.

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

After you've completed the setup, open the solution file HelloModdingWorld.sln in your prefered C# .NET/Mono development environment. 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.

Installation

To install the HelloModdingWorld mod, copy the build's HelloModdingWorld.dll into the Plugins folder in Techblox's main folder.