Web client for Mucklet.com, a textual world of roleplay.
Install Git and NodeJS, and run the following commands:
git clone https://github.com/mucklet/mucklet-client.git
cd mucklet-client
npm install
npm run client:realm:test
Open a browser and go to the URL below, but replace <USER> and <PASS> with the
URL encoded
username and password of your Mucklet developer account:
http://localhost:6450/?auth.player=<USER>&auth.pass=<PASS>
The Mucklet Client is a Single Page Application, written in pure Javascript, compiled into a bundle using Webpack.
The application uses multiple experimental technologies, unfamiliar to most developers. So, when working with this client, make sure to read the overviews:
- Understanding modules
- Understanding events
- Understanding the API
- Understanding components
- Understanding the folder structure
Mucklet.com uses the IP2Location LITE database for IP geolocation.
To learn how to contribute to the project, read the How to contribute guide.
All contributed code should follow the style guide.