{"id":26519805,"url":"https://github.com/tarnadas/net64plus-server","last_synced_at":"2025-03-21T11:33:55.101Z","repository":{"id":40294837,"uuid":"132254727","full_name":"Tarnadas/net64plus-server","owner":"Tarnadas","description":null,"archived":false,"fork":false,"pushed_at":"2022-12-09T08:47:49.000Z","size":4821,"stargazers_count":70,"open_issues_count":20,"forks_count":10,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-19T23:55:14.506Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Tarnadas.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-05-05T14:22:23.000Z","updated_at":"2024-02-28T11:42:02.000Z","dependencies_parsed_at":"2023-01-25T13:31:31.110Z","dependency_job_id":null,"html_url":"https://github.com/Tarnadas/net64plus-server","commit_stats":null,"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tarnadas%2Fnet64plus-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tarnadas%2Fnet64plus-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tarnadas%2Fnet64plus-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Tarnadas%2Fnet64plus-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Tarnadas","download_url":"https://codeload.github.com/Tarnadas/net64plus-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244790744,"owners_count":20510800,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-21T11:31:35.930Z","updated_at":"2025-03-21T11:33:55.060Z","avatar_url":"https://github.com/Tarnadas.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Net64+ Server\n\n[![GitHub All Releases](https://img.shields.io/github/downloads/Tarnadas/net64plus-server/total)](https://github.com/Tarnadas/net64plus-server/releases)\n[![GitHub Releases](https://img.shields.io/github/downloads/Tarnadas/net64plus-server/latest/total)](https://github.com/Tarnadas/net64plus-server/releases)\n[![Docker Pulls](https://img.shields.io/docker/pulls/tarnadas/net64plus-server)](https://hub.docker.com/r/tarnadas/net64plus-server)\n[![Docker Image Size](https://img.shields.io/docker/image-size/tarnadas/net64plus-server)](https://hub.docker.com/r/tarnadas/net64plus-server)\n[![LGTM Grade](https://img.shields.io/lgtm/grade/javascript/github/Tarnadas/net64plus)](https://lgtm.com/projects/g/Tarnadas/net64plus)\n[![Discord](https://discordapp.com/api/guilds/559982917049253898/widget.png)](https://discord.gg/GgGUKH8)\n[![Build Status](https://api.travis-ci.org/Tarnadas/net64plus-server.svg?branch=master)](https://travis-ci.org/Tarnadas/net64plus-server)\n[![Coverage Status](https://coveralls.io/repos/github/Tarnadas/net64plus-server/badge.svg?branch=master)](https://coveralls.io/github/Tarnadas/net64plus-server?branch=master)\n\nNet64 aka SM64O allows playing Super Mario 64 in an online multiplayer mode. Net64+ is the official continuation of the program and features an integrated server list.\n\nThis repository includes the dedicated server software. For the client please visit the [client repository](https://github.com/Tarnadas/net64plus).\n\n## Server List\n\nThere is a [public server list](https://net64-mod.github.io/servers) of all Net64+ server, that have enabled listing.\n\n## Downloads\n\nFor user servers, there is a prebuilt Windows version with a few limitations, but it is much easier to host in general.\nThe prebuilt version is bundled with the [Net64+ Client](https://github.com/Tarnadas/net64plus/releases), but you can also download it in the [release section](https://github.com/Tarnadas/net64plus-server/releases).\n\n## Installation\n\n- download and install [Node 12](https://nodejs.org/en/download/)\n  - you can try using a later version of Node, but you will need to install C++ compilers\n    - on Windows you can do the following: `npm i -g windows-build-tools` / or use `yarn global add`\n- install yarn. It's a package manager for npm, which is generally faster\n- `git clone` this repository or [download as zip](https://github.com/Tarnadas/net64plus-server/archive/master.zip)\n- modify `settings.json`\n\n```js\n{\n  \"port\": \"3678\", // make sure your port is forwarded\n  \"enableWebHook\": false, // set this to true, if you want your server to be listed\n  \"gamemode\": 1, // the initial gamemode\n  \"enableGamemodeVote\": true, // whether gamemode voting should be enabled\n  \"passwordRequired\": false, // whether password is required to join this server\n  \"name\": \"A Net64+ Server\", // display name for public server list\n  \"domain\": \"\", // domain of your server for public server list. keep it empty, if you don't have a domain\n  \"description\": \"The **best** Net64+ server ever\\n\\n:unicorn_face:\", // description for public server list\n  \"apiKey\": \"\" // this is required, if you want your server to be listed\n}\n```\n\n- (OPTIONAL) if you want your server to be listed, go to [SMMDB](https://smmdb.net), login with Google, go to profile and get your API key\n  - _Do not share your API key, because it gives full access to your account_\n  - You can only list one server per API key\n  - `name` will be shortened to 40 characters at most\n  - `description` will be shortened to 200 characters at most\n  - `description` supports [Markdown](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) and [emojis](https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json)\n- open a terminal in the folder of your server and execute the following commands\n\n```bash\n$ yarn install\n$ yarn start\n```\n\n- (OPTIONAL) if you want to run your server indefinitely with auto restarts, I suggest to use pm2\n\n```bash\n$ yarn global add pm2\n$ yarn build\n$ pm2 start ./dist --name=\"net64 server\"\n```\n\n## Docker\n\nYou can also pull [Net64+ Server from Docker Hub](https://hub.docker.com/r/tarnadas/net64plus-server).\n\nMake sure that [Docker is installed](https://docs.docker.com/get-docker/) and running.\nThen execute the following commands:\n\n```bash\n$ docker run --rm -it -p 3678:3678 tarnadas/net64plus-server\n$\n$ # or run it detached in background\n$ docker run --rm -it -d -p 3678:3678 tarnadas/net64plus-server\n```\n\nYou will still need to port-forward in order for this to work.\n\nThe Docker Container accepts all arguments that the regular Net64+ Server executable accepts as well.\n\n```bash\nOptional arguments:\n  -h, --help            Show this help message and exit.\n  --port PORT, -P PORT\n  --gamemode GAMEMODE, -g GAMEMODE\n  --disableGamemodeVote, -G\n  --passwordRequired, -pr\n  --password PASSWORD, -p PASSWORD\n  --name NAME, -n NAME\n  --domain DOMAIN, -D DOMAIN\n  --description DESCRIPTION, -d DESCRIPTION\n  --enableWebHook, -w\n  --apiKey APIKEY, -k APIKEY\n  --verbose, -v\n  --skipPortCheck, -s\n```\n\nAn example to host a public server on port 8080:\n\n```bash\n$ docker run --rm -it -d -p 8080:8080 tarnadas/net64plus-server -P 8080 -w -k $API_KEY -n \"Public Net64+ Server\" -d \"This is a publicly hosted Net64+ Server\"\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftarnadas%2Fnet64plus-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftarnadas%2Fnet64plus-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftarnadas%2Fnet64plus-server/lists"}