Skip to content
This repository has been archived by the owner on Feb 28, 2024. It is now read-only.

Latest commit

 

History

History
80 lines (54 loc) · 3.96 KB

README.md

File metadata and controls

80 lines (54 loc) · 3.96 KB
Raw

NeosModLoader

A mod loader for Neos VR. Consider joining our community on Discord for support, updates, and more.

Installation

If you are using the Steam version of Neos you are in the right place. If you are using the standalone version, read the Neos Standalone Setup instructions. If you are on Linux, read the Linux Notes.

  1. Download NeosModLoader.dll to Neos's Libraries folder (C:\Program Files (x86)\Steam\steamapps\common\NeosVR\Libraries).
  2. Place 0Harmony.dll into a nml_libs folder under your Neos install directory (C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_libs). You will need to create this folder.
  3. Add mod DLL files to a nml_mods folder under your Neos install directory (C:\Program Files (x86)\Steam\steamapps\common\NeosVR\nml_mods). You can create the folder if it's missing, or simply launch Neos once with NeosModLoader installed and it will be created automatically.
  4. Add the following to Neos's launch options: -LoadAssembly Libraries\NeosModLoader.dll, substituting the path for wherever you put NeosModLoader.dll.
  5. Start the game. If you want to verify that NeosModLoader is working you can check the Neos logs. (C:\Program Files (x86)\Steam\steamapps\common\NeosVR\Logs). The modloader adds some very obvious logs on startup, and if they're missing something has gone wrong. Here is an example log file where everything worked correctly.

If NeosModLoader isn't working after following those steps, take a look at our troubleshooting page.

Example Directory Structure

Your Neos directory should now look similar to the following. Files not related to modding are not shown.

<Neos Install Directory>
│   Neos.exe
│   NeosLauncher.exe
│
├───Logs
│       <Log files will generate here>
│
├───nml_mods
│       InspectorScroll.dll
│       MotionBlurDisable.dll
│       NeosContactsSort.dll
|       <More mods go here>
├───nml_libs
│       0Harmony.dll
|       <More libs go here>
│
└───Libraries
        NeosModLoader.dll

Note that the libraries can also be in the root of the Neos install directory if you prefer, but the loading of those happens outside of NML itself.

Finding Mods

A list of known mods is available in the Neos Mod List. New mods and updates are also announced in our Discord.

Frequently Asked Questions

Many questions about what NML is and how it works are answered on our frequently asked questions page.

Making a Mod

Check out the Mod Creation Guide.

Configuration

NeosModLoader aims to have a reasonable default configuration, but certain things can be adjusted via an optional config file.

Contributing

Issues and PRs are welcome. Please read our Contributing Guidelines!

Licensing and Credits

NeosModLoader is licensed under the GNU Lesser General Public License (LGPL). See LICENSE.txt for the full license.

Third-party libraries distributed alongside NeosModLoader:

Third-party libraries used in source: