mirror of https://github.com/hack-chat/main.git synced 2024-03-22 13:20:33 +08:00

Go to file

Change verifyNickname to es5 rather than es6.

We're not really using much es6 features, so we might as well make this a normal function so that people with browsers that are old due to not being able to update them (such as apple devices not getting updates the os after end of life). Also replaces the `const` with a `var` since it doesn't really matter if it's modified or not and that is an es6 feature was well.
This might fix https://github.com/hack-chat/main/issues/33 or at least the issues 'CheekyChops' having. I didn't test this code, but it's such a simple change.

2019-01-13 16:08:16 -06:00

client

Change verifyNickname to es5 rather than es6.

2019-01-13 16:08:16 -06:00

clientSource

cleaned up and commented modules

2018-06-04 00:07:24 -07:00

documentation

documentation update, removing unused scripts

2018-10-13 16:35:58 -07:00

server

Add a check for if there is a target parameter

2018-12-28 10:06:00 -06:00

.gitignore

Flatten

2018-05-13 16:09:55 +05:30

CHANGELOG.md

Added hooks, modules and cleaned up code

2018-09-29 23:44:36 -07:00

index.js

streamline dev flow

2018-05-19 17:21:08 -07:00

LICENSE

Add license as a file in the repo as GitHub's documentation

2018-05-11 19:33:08 +05:30

package-lock.json

Added hooks, modules and cleaned up code

2018-09-29 23:44:36 -07:00

package.json

Added hooks, modules and cleaned up code

2018-09-29 23:44:36 -07:00

README.md

Completed protocol decoupling

2018-06-03 11:08:35 -07:00

README.md

hack.chat

hack.chat is a minimal, distraction-free, accountless, logless, disappearing chat service which is easily deployable as your own service. The current client comes bundled with LaTeX rendering provided by KaTeX and code syntax highlighting provided by highlight.js.

A list of software developed for the hack.chat framework can be found at the 3rd party software list repository. This includes bots, clients, docker containers, etc.

This is a backwards compatible continuation of the work by Andrew Belt. The server code has been updated to ES6 along with several new features including new commands and hot-reload of the commands/protocol. There is also documentation and a changelog.

Installation

Prerequisites

node.js 8.10.0 or higher
npm 5.7.1 or higher

Developer Installation

Clone the repository: git clone https://github.com/hack-chat/main.git
Change the directory: cd main
Install the dependencies: npm install
Launch: npm start

If you change the websocketPort option during the config setup then these changes will need to be reflected on line 60 of client.js.

Live Deployment Installation

See DEPLOY.md

Contributing

If you are modifying commands, make sure it is backwards compatible with the legacy client and you update the documentation accordingly.
Use the template to learn how to create new commands.
Use two space indents.
Name files in camelCase.
Scripts that do not default to strict mode (such as modules) must use the 'use strict' directive.

Credits

Marzavec - Initial work
MinusGix - Base updates
Neel Kamath - Base Documentation
Carlos Villavicencio - Syntax Highlighting Integration
OpSimple - Modules Added: dumb.js & speak.js
Andrew Belt, https://github.com/AndrewBelt, for original base work
wwandrew, for finding server flaws (including attack vectors) and submitting ~~incredibly detailed~~ bug reports
Everyone else who participated in this project.

License

This project is licensed under the WTFPL License.