pyramid-irc
v0.4.1
Published
Web-based IRCv3 client with bouncer, and support for Twitch features
Downloads
26
Readme
Pyramid
NEW! Pyramid 1.0 beta 4 is out! Woohoo!
(Below is a beta 1 screenshot that's pretty outdated, but it gives a general idea of its looks.)
About
Get real time status of your friends on any IRC network, and talk to them too! Stay online even when you're not viewing chat, and see what happened when you were gone. Browse logs.
- Supports Twitch features, so it's almost exactly like Twitch Chat.
- Has responsive layout, so it also works great on your phone.
It works in real time by directly connecting a Node IRC connection to a Socket.io connection. If you click on one of the usernames, you can see what they've said in all the rooms you monitor in.
Installation instructions
- Install Node.js (version 7+ required)
- Run
npm install --production
from a terminal in the project directory to set up the prerequisites - Run
node pyramid.js
from the project directory to start the server. (You could use a service like Forever to help keep it running) - Open your browser and navigate to the hostname and port you defined in step 3 (usually
localhost:8887
)
First time you open the page, there's gonna be a guide helping you. Have fun!
Edge build installation with easy update
If you want an installation that's always up to date with the newest development build, it's easiest to do a read-only Git repository clone that you can pull from. It goes like this:
- Make sure Git is installed on your system
- Run
git clone git://github.com/graulund/pyramid.git
from a terminal and navigate to the directory it creates - Run
git checkout development
to move to the development branch - Follow above installation instructions
Then, when you want to update your version, simply run git pull
in a terminal from the Pyramid folder. If it tells you that there are changes in the package.json
file, then run npm install --production
again, to make sure the prerequisites are up to date.
Warning: Development builds can obviously fail more often than the master build.
Installing on Windows
Node.js projects often require a little more effort to be installed on Windows, and this is also the case with this project. Pyramid uses a few dependencies that require the compiling of C++ code, so in order to get the project up and running, you will have to run the following command in a PowerShell opened as an admin:
npm install --global --production windows-build-tools
This command installs build tools required to set up Pyramid on Windows.
Other than the above command in particular, I would generally recommend using something like Git Bash to run your commands in on Windows.
In order to install the dependency Sodium, which encrypts your passwords, you unfortunately need to install Microsoft Visual Studio 2015 and then run the following command before continuing your installation:
npm config set msvs_version 2015 --global
For more information, refer to the Sodium documentation.