mukteshkrmishra/Kaetram-Open

An open-source 2D HTML5 adventure based off BrowserQuest (BQ).

Kaetram

Kaetram is an open-source game-engine created to aid those interested in entering the game development realm. The codebase is simple, clean, and intuitive. This project is intended to be used as a learning tool. The original idea is based on Little Workshop's demo game—BrowserQuest (BQ). This game uses original BQ assets as well as custom-made ones. The entire code-base has been written from scratch, using more modern approaches.

Live Version – https://kaetram.com

Join us on Discord – https://discord.gg/MmbGAaw

Patreon – https://www.patreon.com/kaetram

Table of Contents

• Kaetram
  • Table of Contents
  • Features
    • Regions
    • Tilemap
    • Map Parsing
    • Kaetram Hub
  • Get Started
    • Prerequisites
      • NOTE: Node.js
      • NOTE: MongoDB
    • Installing and Running
  • Roadmap
    • TODO
      • Gameplay
      • Code-base Development
      • Miscellaneous
  • License

Features

BQ was intended as an experiment to showcase HTML5 capabilities, since then, technology has only served to advance. Kaetram contains a lot of ideas and features that builds on top of its predecessor, a couple are:

• Multiplayer using Socket.IO
• Enhanced rendering engine (includes dynamic lighting, overlays, animated tiles)
• Region system (client receives only necessary data and saves it)
• Questing and achievements system.
• Plugin-based combat system (for bosses/special enemies).
• Supports RESTful API.
• Discord server integration.
• Cross-server private messaging and interactions.
• Lerna monorepo packaging
• And much more

Regions

The region system sends data to the client according to the map data of the server. The collisions are checked both server-side and client-side to avoid cheating. The region system makes use of dynamic tiles, which are unlocked according to a player's progress. Furthermore, there is integrated support for instancing, where we can use a section of the map (or clone it) and reuse it for certain groups of players. The instancing is perfect for activities such as minigames, where we will want to run multiple instances in parallel.

Tilemap

Kaetram is built with modularity in mind, as such, the client supports multiple tileset parsing. The tilemap can easily be constructed using Tiled Map Editor. Using our map parsing tool located in tools/map/exportmap.js you can easily export your creation to both the client and the server.

Map Parsing

Once you finish modifying your map in tools/maps/data you can parse the map data by executing exportmap.js in tools/maps directory. Example command:

./exportmap.js ./data/map.json

In order to build the current game map you can run

npm run map

Kaetram Hub

There is also support for a hub server. This can help connect servers across one another, allowing players to interact with their friends across them in a variety of ways (private messaging and guilds). Furthermore, the hub serves as a gateway for determining what server to place players in. If a server is full, it simply returns another server that has room for the player.

Get Started

Prerequisites

You must first install Node.js to run the server, and install MongoDB database to store user data.

NOTE: Node.js

Node.js version must be greater than or equal to 10.0.0 as anything under this version would interpret something like catch {} instead of the usual catch (err) {} as a Syntax Error. This error is not in this codebase, it's in one of the necessary node modules currently installed

NOTE: MongoDB

MongoDB is a requirement for Kaetram to run with all the features enabled, but you can still run your own limited version if you do not want to install MongoDB. To do this, set Config.offlineMode = true in the server configuration. If you do choose to install MongoDB, a user is not necessary, but you can enable authentication with the Config.mongoAuth variable in the server configuration.

After installing Node.js, install all packages by running

npm install

Installing and Running

Before starting Kaetram, there is some configuration that must be done. In server/ directory, rename config.js-dist to config.js. Modify the file as to fit your needs. Similar procedure for the client/data directory, simply rename config.json-dist to config.json. Make sure the settings in the client match those in the server.

MongoDB is a requirement for Kaetram to run with all the features enabled, but you can still run your own limited version if you do not want to install MongoDB. To do this, set offlineMode = true in the server configuration.

If you do choose to install MongoDB, a user is not necessary, but you can enable authentication with the mongoAuth variable in the server configuration.

As of now a production build is not available so for running a development server, run

npm run dev

Roadmap

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).

TODO

Gameplay

• Finalize the new map.
• Polish mob attributes.
• Have a consistent storyline that goes with the game.
• Implement special abilities and weapon perks.
• Improve anti-cheating detections.
• Add PvP
• Add minigames (PvP, Capture the Flag, Hold the Base)
• Improve client/server synchronization for all players
• Add player trading abilities
• Transition to a more suitable WebGL framework
• Add friends list
• Improve the enchanting system
• Make bosses more responsive
• All trees in the world must be cuttable

Code-base Development

• Write documentation outlining the entirety of the source code.
• Improvements and optimizations to the lighting system.

Miscellaneous

• Add (continue) to NPC talking—spacebar when talking

License

This project is distributed under the MPL-2.0 License. See LICENSE for more information.