Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 2.77 KB

README.md

File metadata and controls

59 lines (46 loc) · 2.77 KB
Raw

Net64

Travis AppVeyor Discord

Net64 is a work in progress Super Mario 64 modification providing fully featured cooperative multiplayer over the internet. It is written in C / C++ targeting Windows and Linux operating systems.
Net64 provides the necessary components to run N64 games, apply modifications, initialize hooks, host / connect to multiplayer sessions and synchronize gamestate. Currently the project is in early development and not ready for general use.

Contributing

If you want to contribute code please take a look at our contributing guide. You should as well contact one of the developers on our discord server in order to know about the current state of the project.
If you'd like to help the project out in other ways like in-depth testing, server hosting or website development you can also ask there.

Building on Windows

Required tools

  • Visual Studio 2019 with CMake support
  • Git

Dependencies

  • Qt 5.12

Steps

  • Clone the repository and pull submodules git clone --recursive https://github.com/net64-mod/net64-coop.git
  • Open the CMakeLists.txt file in the project root with Visual Studio
  • If not automatically detected, tell cmake about dependencies
  • Click Build or Install

Building on Linux

Required tools

  • CMake
  • Git
  • C++ 17 compatible compiler

Dependencies

  • Qt 5.12

Steps

  • Clone the repository and pull submodules git clone --recursive https://github.com/net64-mod/net64-coop.git
  • Create and enter build directory mkdir net64-coop/build && cd net64-coop/build
  • Run cmake cmake ..
  • Build the project make
  • Install project make install

Bundling Mupen64Plus

Net64 internally uses the Mupen64Plus emulator. On 32Bit Windows and 64Bit Linux builds a build of Mupen64Plus is automatically bundled when running make install. If you are building for a different architecture, you have to manually set MUPEN64PLUS_DIR to point to the correct Mupen64Plus installation. It's recommendet to use a build from the official release section. Be sure to use a Mupen64Plus build with the same OS and architecture as the Net64 build!

In case you don't want to bundle Mupen64Plus you can set the cmake variable INSTALL_MUPEN64PLUS to OFF.