|Project Name||Stars||Downloads||Repos Using This||Packages Using This||Most Recent Commit||Total Releases||Latest Release||Open Issues||License||Language|
|Kaetram Open||387||5 days ago||mpl-2.0||TypeScript|
|Kaetram is an open-source 2D HTML5 MMORPG. It is an extended version of BrowserQuest (BQ).|
|Mir2x||250||18 hours ago||2||C++|
|open source MMORPG game|
|Darkstar||42||11 days ago||mit||C#|
|DarkStar MMO engine|
|Rme||21||10 days ago||4||other||C++|
|OTAcademy fork of Remere's Map Editor repository.|
|A 2d tile-based world built with Phaser framework|
|Vxa Os||13||a year ago||mit||Ruby|
|Most complete and secure free 2D online game creation tool from RPG Maker.|
|🕹🎮 2D MMORPG server & client in JS|
|Mmorpg||11||7 years ago||n,ull||mit||C++|
|[LEGACY] An attempt to make a 2D MMORPG game in C++ as a kid.|
|Slayersworld||11||2 years ago||1||mit||C++|
|MMORPG Framework 2D Inspired by slayersonline|
Kaetram is an open-source 2D MMORPG that expands on the original idea created by Little Workshop's BrowserQuest (BQ). We aim to provide a collaborative gaming experience as well as a game-engine for those interested in creating their own version. The game is still in early development stages and all help, suggestions, and bug reports are welcome. All of the assets are licensed under CC-BY-SA3.0 and we aim to hold onto the original BQ assets as well as expand upon them. The entire code-base has been re-written from scratch, optimized, and documented. Please see the GitHub wiki for information regarding development. Kaetram first started development in 2015 under the name of Tap Tap Adventure (TTA). In 2017, Kaetram was started as a complete re-write of the code which was formerly BQ-based.
Live Version – https://kaetram.com
Join us on Discord – https://discord.gg/MmbGAaw
BQ was initially written as an HTML5 experiment showcasing the capabilities of web technologies back in 2012. Kaetram builds on top of the idea and uses modern standards to help facilitate readability, performance, and compatibility. Some of the many features are as follows:
You must first install Node.js to run the project, and optionally install MongoDB to store user data on the server.
You need to use a Node.js version greater than or equal to
v14.19.0, following the Long Term Support (LTS) schedule, to have the most stable experience when developing/experimenting with Kaetram. Older versions would not work with our current dependencies and package manager.
MongoDB is not a requirement for Kaetram to run, but you can store and save user data if you install it and run an online environment with all the features enabled. To do this, see Configuration, and set
SKIP_DATABASE=false. If you do choose to install MongoDB, a user is not necessary, but you can enable authentication with the
You will also need to enable Yarn through Corepack, to manage our dependencies.
Starting from Node.js
v14.19.0, Corepack is included by default, but is currently opt-in.
To enable it, run
Install the dependencies by simply running
To run live development builds, use
To create production builds, run
Then, to run each production build, use
--host at the end to make the game visible on your network.
Optionally, if you want some additional configuration, There is a file named
.env.defaults, and it's values will be used unless overridden by a new
file, or by setting environmental variables.
Copy and rename
.env, and modify the contents to fit your
Keep in mind, you have to rebuild the client and restart the server every time you change your configuration.
As a prerequisite to run the E2E tests, you need a MongoDB server running as well.
Configuration for test-only environments can be configured on
.env.e2e. All it's values will fallback to
.env, then to
.env.defaults, if present.
To run test on your console, use
Alternatively, if you want to have the test environment open interactively, so you can select the test you want to run in a UI, use
The region system works by segmenting the map into smaller chunks that are then sent to the client. The client caches the map data and stores it for quicker loading in the local storage. When a new map version is present, the client purges the cache and starts the process again. The region system is split into static tiles and dynamic tiles. Static tiles do not undergo a change and are part of the map permanently. Dynamic tiles change depending on conditions such as a player's achievement/quest progress, or, in the case of trees, depending on whether the tree has been cut or not. In the future we plan to use this region system to create instanced versions of areas, for example running multiple minigame instances at the same time.
Video example showcasing region system using an exaggerated example:
Kaetram uses Tiled Map Editor to create and modify the map. Our map parsing tool is used to export a condesed version of the map data. The server receives the bulk of the information and uses it to calculate collisions, tile data information, and areas (pvp, music, etc). The client stores minimal data such as tile 'z-index' and animations.
Once finished modifying your map in
packages/tools/map/data/, you can
parse the map data by executing
yarn exportmap inside the
yarn exportmap ./data/map.json
To build the current game map, you can run
The hub functions as a gateway between servers. Due to performance limitations of NodeJS it is more feasible to host multiple servers instead of one big one containing thousands of players. The hub does exactly that, once the hub is running and a server instance is given the host address for the hub, it will automatically connect. The hub becomes the primary connection point for the client. When a request for connection is received, the hub will pick the first server that has room for the player. Alternatively, it allows players to select any server amongst the list of servers.
To enable the hub server, see Configuration, and set these values to
Here we have The Roadmap Project Board. This is the main board of the Kaetram-Open project. A kind of Kanban tasks board for tracking and presenting the progress to the community. Here we plan, prioritize and track our work.
See also the open issues for a list of proposed features (and known issues).
Patreon – https://www.patreon.com/kaetram
Open Collective – https://opencollective.com/kaetram
For all inquiries about purchasing a different license or commission work, please contact @Keros on Discord.
This project is distributed under the
Mozilla Public License Version 2.0. See
LICENSE for more information.