/PrimitierOnlineMod

Mod to add a multiplayer mode to Primitier.

Primary LanguageC#MIT LicenseMIT

PrimitierOnlineMod

Mod to add a multiplayer mode to Primitier.
View the wiki »

Report Bug · Request Feature

Table of Contents
  1. About The Project
  2. Getting Started with Client
  3. Getting Started with Server
  4. Contributing
  5. License
  6. Contact
  7. Acknowledgments

About The Project

This project was created to create a mod to add a multiplayer mode to the VR sandbox game Primitier.

Getting Started with Client

How to install the mod to Primitier.

Prerequisites

Install the tools needed to install the mod.

Installation

  1. download the mod from the release page.
  2. put PrimitierOnlineMod.dll and settings.json in Primitier/Mods folder.
  3. Play Primitier!

Getting Started with Server

How to build a server using Docker.

Prerequisites

Install the tools needed to build the server.

  • Git 
    apt install git
  • Docker 
    apt install docker

Installation

  1. Clone GitHub repository. 
    git clone https://github.com/YutoMaeda1209/PrimitierOnlineMod.git
  2. Edit the Server/settings.json file.

Note

If you change the Port parameter, change the port number in the command arguments in section 4.

  1. Create a Docker image. 
    docker build -t pom-image -f .\Dockerfile .
  2. Run a Docker container. 
    docker run --name pomServer --mount 'src=pomVolume,dst=/mnt/pom' -d -p 54162:54162 -p 54162:54162/udp pom-image

Tip

If you want to destroy the container after it has been terminated, replace --name pomServer with --rm.

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

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". Don't forget to give the project a star! Thanks again!

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

Top contributors:

contrib.rocks image

License

Distributed under the MIT License. See LICENSE for more information.

Contact

YutoMaeda - Discord Discussion

Acknowledgments

We would like to thank everyone involved in this project.