This repository has been archived on 2022-11-26. You can view files and clone it, but cannot push or open issues or pull requests.
teemant-old/README.md

25 lines
715 B
Markdown
Raw Normal View History

2016-09-22 15:41:37 +00:00
# TeemantIRC
2016-09-25 09:16:06 +00:00
LunaSquee's third attempt at creating a working IRC client..
2019-01-09 17:26:09 +00:00
### Running the development version
2016-09-25 09:16:06 +00:00
This application requires [node.js](https://nodejs.org/) to be installed.
1. Install the dependencies `npm install`
2. Copy the configuration `cp client.config.example.toml client.config.toml`
2019-01-09 17:26:09 +00:00
3. Build the project using `npm run build`
4. Run the server `npm start`
2016-09-25 09:16:06 +00:00
2019-01-09 17:26:09 +00:00
The client will be accessible at http://localhost:9000/
2016-09-25 09:16:06 +00:00
2016-09-25 13:09:55 +00:00
### WebIRC
2016-11-05 18:52:58 +00:00
The server will look for passwords in `webirc.data.json`. The format is:
```
"server_hostname": {
"password": "server webirc password",
"cached_ip": null,
"last_update": 0
}
```
It will DNS resolve `server_hostname` every `config.webirc.resolveInterval` seconds.