Skip to content

WorldBoxOpenMods/ModLoader

Repository files navigation

logo
NeoModLoader

zh en
中文介绍 | README in English
The logo is generated by Image Creator on 2023/10/13. Inform the remedy if there is infringement.

A new mod loader for Worldbox after NCMS, called NML for short. Detailed introduction look Gitbook.

Overview

How to install

One-click install(Windows only)

https://drive.google.com/file/d/1le-loCzEc2m5sxtSalz7RD6tJqtHRUZZ/view?usp=sharing The installer only works for Windows.

Manual install

  1. Download NeoModLoader.dll (and NeoModLoader.pdb) in "releases" at the right of the page and put it in GAMEPATH/worldbox_Data/StreamingAssets/mods folder
  2. Delete NCMS_memload.dll (They can be installed together but not suggested)
  3. Start the game with experimental mode enabled

It is recommended to subscribe to the NML item on the Steam Workshop to receive automatic updates

Others

You can contribute to accelerate the English Version

How to compile NML

Compile with IDE

  1. clone
  2. Open NeoModLoader.csproj with IDE(VS/Rider/others) and click "Build"

Compile with command

  1. clone
  2. Download and install .NET Core SDK
  3. cd path-to-folder-of-NeoModLoader.csproj
  4. Run dotnet build NeoModLoader.csproj

How to contribute

All contributions are welcome. But to avoid time wasted, follow the below steps.

For small fixes:

  1. Fork
  2. Coding
  3. Pull request
  4. Wait for result

New features or code reconstruction:

  1. New issue about what you want to do and simple reasons about it
  2. After discussion, do it as small fixes.

Future roadmap

  1. Auto layout window
  2. Mod one-click install for various platforms
  3. Manage vanilla tab buttons
  4. Assembly-CSharp mod support(modify game code)