mucklet-client

KO | EN

gitlite — search

#python #java #python3 #arduino #golang #machine-learning #rust #html #flask #javascript #seismology #nodejs

★ 10 Open GitHub ↗

Web client for Mucklet.com, a textual world of roleplay.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h2 align="center"><b>Mucklet Web Client</b></h2>

Web client for Mucklet.com, a textual world of roleplay.

# Quick start

Install [Git](https://git-scm.com/downloads) and
[NodeJS](https://nodejs.org/en/download/), and run the following commands:

```text
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](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/encodeURIComponent)
username and password of your Mucklet developer account:
```text
http://localhost:6450/?auth.player=<USER>&auth.pass=<PASS>
```

# About

The Mucklet Client is a Single Page Application, written in pure Javascript,
compiled into a bundle using Webpack.

## Understanding the application

The application uses multiple experimental technologies, unfamiliar to most
developers. So, when working with this client, make sure to read the overviews:

* [Understanding modules](./docs/understanding-modules.md)
* [Understanding events](./docs/understanding-events.md)
* [Understanding the API](./docs/understanding-api.md)
* [Understanding components](./docs/understanding-components.md)
* [Understanding the folder structure](./docs/understanding-folders.md)

## Attribution

Mucklet.com uses the IP2Location LITE database for [IP geolocation](https://lite.ip2location.com).

# Contributing

To learn how to contribute to the project, read the [How to contribute](./docs/CONTRIBUTE.md) guide.

## Style guide

All contributed code should follow the [style guide](./docs/style-guide.md).

mucklet-client

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README