/CVR_Mods

Primary LanguagePowerShellGNU Lesser General Public License v2.1LGPL-2.1

Contributors Forks Stargazers Issues LGPL2 License


NovaVoidHowls's CVR Mods


Explore the docs »

Report Bug · Request Feature

Table of Contents
  1. About
  2. Mod List
  3. Building
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments
  8. Project tools

About

Welcome to my little collection of mods for ChilloutVR, feel free to leave bug reports or feature requests!


⚠️ Notice! ⚠️

This project is an independent creation and is not affiliated with, supported by, or approved by Alpha Blend Interactive


(back to top)

Mods List

Mod name More Info State Latest Version Git Latest Version CVRMG Description
DataFeed README.md Ready 0.0.3 0.0.3 - pending approval Exposes certain interface values as Avatar parameters

Building

In order to build the mods in this project:

  • (1) Install NStrip.exe from https://github.com/BepInEx/NStrip into this directory (or into your PATH). This tools converts all assembly symbols to public ones! If you don't strip the dlls, you won't be able to compile some mods.
  • (2) If your ChilloutVR folder is C:\Program Files (x86)\Steam\steamapps\common\ChilloutVR you can ignore this step. Otherwise follow the instructions bellow to Set CVR Folder Environment Variable
  • (3) Run copy_and_nstrip_dll.ps1 on the Power Shell. This will copy the required CVR, MelonLoader, and Mod DLLs into this project's /.ManagedLibs. Note if some of the required mods are not found, it will display the url from the CVR Modding Group API so you can download.

Set CVR Folder Environment Variable

To build the project you need CVRPATH to be set to your ChilloutVR Folder, so we get the path to grab the libraries we need to compile. By running the copy_and_nstrip_dll.ps1 script that env variable is set automatically, but only works if the ChilloutVR folder is on the default location C:\Program Files (x86)\Steam\steamapps\common\ChilloutVR.

Otherwise you need to set the CVRPATH env variable yourself, you can do that by either updating the default path in the copy_and_nstrip_dll.ps1 and then run it, or manually set it via the windows menus.

Setup via editing copy_and_nstrip_dll.ps1

Edit copy_and_nstrip_dll.ps1 and look the line bellow, and then replace the Path with your actual path. $cvrDefaultPath = "C:\Program Files (x86)\Steam\steamapps\common\ChilloutVR"

You'll probably need to restart your computer so the Environment Variable variable gets updated...

Now you're all set and you can go to the step (2) of the Building instructions!

Setup via Windows menus

In Windows Start Menu, search for Edit environment variables for your account, and click New on the top panel. Now you input CVRPATH for the Variable name, and the location of your ChilloutVR folder as the Variable value

By default this value would be C:\Program Files (x86)\Steam\steamapps\common\ChilloutVR, but you wouldn't need to do this if that was the case! Make sure it points to the folder where your ChilloutVR.exe is located.

Now you're all set and you can go to the step (2) of the Building instructions! If you already had a power shell window opened, you need to close and open again, so it refreshes the Environment Variables.

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are appreciated. Please see CONTRIBUTING.md for more details.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

Please see LICENSE for information.

(back to top)

Contact

@NovaVoidHowl

Project Link: https://cvr-mods.dev.novavoidhowl.uk

(back to top)

Acknowledgments

Thanks for your assistance with getting started on Mellon Loader Mods

(back to top)

Project tools

  • VS Code, ide
  • Pre-Commit, linting and error detection
  • Github Copilot, Code error/issue analysis

(back to top)