Skip to content

Plugin to transform RPG Maker MZ to MMORPG Maker MZ (Server)

License

Notifications You must be signed in to change notification settings

Pixel-Map/MMORPGMaker-MZ-Server

Repository files navigation

MMORPG Maker MZ (Server)

Disclaimer : You have to own both RPG Maker MV and MZ licenses in order to use this repack !


Summary

(This repository contains the server ONLY. You should probably be at the official repository here: https://github.com/Andaroth/MMORPGMaker-MZ)

Hello, my name is Axel Fiolle.

I started this project in late 2020. I discovered the MMO plugin project by Samuel Cardillo and was quite impressed by the quality of the result. Samuel and his community have made good work on it. It was running on RPG Maker MV –which runs in JavaScript– and as a web developer I decided to make my very own MMO with it because I'm quite good with the technos the project uses. After some weeks working on my game, I started to feel the need to have a better engine so I decided to migrate the MMO_Core plugins from MV to RPG Maker MZ. After some tricky fixes and "bandages" I finally produced something surprisingly stable.

What's different about this repository?

This is the server code from Andaroth's repository, with a few slight changes. It's converted to TypeScript now, and utilizes Mikro-Orm for the database (so that you can plug and play whichever one you'd like, I'm using Postgres at the moment)

In order to use this, copy the .env.dist file, and update it with the right credentials and path to your Game. Then run: npm i && npm build && npm start

History

Samuel Cardillo has used RPG Maker since its 2000 version. Discovered it when he was a kid and used it to make many (very bad he says) games. It clearly impacted a lot on his creativity and his development desires. Later on, as a French-speaking person, he discovered a (now dead) project named FROG Creator which was a dedicated at creating MMORPG in a RPG Maker-like environment.

With the release of RPG MAKER MV which allows usage of JavaScript and its HTML5 export, he decided to give it a try and discovered quickly that yes, RPG Maker MV could easily be used to create an MMORPG creator interface.

I joined the project in September 2020 and made the MZ version a few weeks later, after discovering it was easy to migrate basic MMO features to RPG Maker MZ.


How to use ?

Visit the official repo! https://github.com/Andaroth/MMORPGMaker-MZ

  1. Watch the MV tutorial video to learn the basics
  2. Then take a look at the MZ tutorial :

Watch the tutorial

Note : It's not needed to touch any package file anymore

Plugins requirement

Disclaimer : The following files are already contained in the project.

Launch steps

  1. git clone the repo

  2. Check that you're on to the MMOMZ/develop branch

  3. Install NodeJS

  4. Install RethinkDB

  5. Run rethinkdb in a terminal

  6. Run npm install then node mmo.js in the server/ folder

  7. Congratulations ! You can now play, develop, improve, overcome and do your stuff :)

Keep the game up to date on players browser

  1. Deploy your game
  2. Edit your game...
  3. Once you're done, change the CacheOverride gameVersion parameter in the plugin manager
  4. Upload/Update your game on a website

Documentation

-Are you a developer ? Read the developer documentation

-Are you a maker ? Read the maker documentation

Current functionalities

  • Administrator command to add and remove synchronised NPCs
  • Synchronised NPC random movements
  • Synchronised player movements
  • Synchronised skins
  • Account creation (password hashed with SHA256 + customizable salt)
  • RESTFUL API support (with JSON Web Token)
  • Persistance of position & skin
  • Persistance of player stats
  • Persistance of inventory & equipments
  • Persistance of local switches
  • Persistance of party switches
  • Persistance of global switches
  • Persistance of local variables
  • Persistance of global variables
  • Global and local map system
  • Party system
  • Party combat system
  • Respawn system
  • In-game chat
  • Registration page

Logging

The server utilizes PinoJS to streamline logging. By default, output is colorized to STDOUT, as well as output as JSON to a dated file. To adjust the log level, just set the environment variable "PINO_LOG_LEVEL" to the desired level (from most to least verbose -- "trace", "debug", "info", "warn", "error", and "fatal").

Admin Panel

The Admin panel must be generated via Polymer for now.

To do so, run the following:

cd src/admin_dev
npm i
bower i
polymer build
rm -Rf ../admin && mv build/custom-unbundled ../admin

This repack includes Creative Commons graphics by :

  • Avery
  • Chalkdust
  • hidenone
  • whtdragon

See the progress : https://trello.com/b/m4leXuBa/mmorpg-maker-mv-version-1-todo-list

Join us on Discord : https://discord.gg/GVqyAwp

Check the original project : https://github.com/Andaroth/MMORPGMaker-MZ

About

Plugin to transform RPG Maker MZ to MMORPG Maker MZ (Server)

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published