Burd IRC¶
Latest Stable: Burd IRC 0.6.1
Latest Development: Burd IRC 0.6.2 (Release Candidate 2)
Welcome to the documentation for Burd IRC client. https://github.com/burdirc/burd Need help with something that is not on our docs? Come visit us on chat.freenode.net SSL: 6697 Non-SSL: 6667 in the channel #burdirc
Warning
Please remember that this documentation is far from complete and there will always be modifications as new versions are added and things are fixed.
Frequently Asked Questions¶
These questions are not frequently asked yet. But if you have a question the answer could be here.
Where can I download Burd IRC?¶
If you visit our releases page on our GitHub repository, you will be able to download the exe file to install Burd IRC. Releases Page: https://github.com/burdirc/burd/releases/
Can Burd IRC run on Android?¶
No Burd IRC is not supported on Android.
Download and Installing (Windows)¶
This guide will tell you how to download install the latest version of the Burd IRC client.
System Requirements:
OS: Windows 7 or later.
Min RAM: 1 GB
ia32 (x86) and x64 binaries supported.
Installing¶
Step One: Download Burd IRC Installer¶
First, you need to download the Burd IRC Installer from the _`GitHub releases page`_ page in the Burd repo.
Step Two: Run The Installer Exe¶
Run the Burd IRC installer exe file by opening the file.
Step Three: Burd IRC Is Installed!¶
Now Burd IRC is installed! An icon for Burd IRC should be on your desktop. Just click on the Burd IRC icon to start using Burd!
Download and Installing (UNIX)¶
This page will tell you how to download, and install Burd IRC for UNIX-like systems.
System Requirements:
System Requirements can be viewed here: https://github.com/electron/electron/blob/master/docs/tutorial/support.md
Installing - Method 1¶
Step One: Install Snapd¶
First you will want to install snapd. You can find out how to do this by going to the URL below and following the instructions for your distribution.
Step Two: Run The Following Commands In The Terminal.¶
sudo snap install burdirc
Now the latest version of the Burd IRC client is installed!
Download and Installing (Git)¶
This guide will tell you how to download install the git version of Burd IRC.
Requirements
NodeJS: Download and install NodeJS from https://nodejs.org/en/download/
Installing - Windows¶
Step One: Download the GitHub repo.¶
Download the Burd IRC GitHub repo from https://github.com/burdirc/burd
Step Two: Unzip and open burd-master.zip¶
Unzip the burd-master.zip then open the unzipped folder.
Step Three: Open a command prompt in the burd folder¶
Now you will need to open a Windows command prompt in the folder with the source code.
Once you do that run the following commands in the command prompt.
npm install electron
Then run:
npm start
Burd IRC will then open and be running on the latest development version of Burd IRC from GitHub!
Installing - macOS¶
Step One: Download the GitHub repo.¶
Download the Burd IRC GitHub repo from https://github.com/burdirc/burd
Step Two: Open the burd-master¶
Unzip the burd-master.zip then open the unzipped folder.
Step Three: Open Command Prompt¶
Now you will need to open a command prompt and cd to the burd-master folder.
Once you do that run the following commands in the command prompt.
npm install electron
Then run:
npm start
Burd IRC will then open and be running on the latest development version of Burd IRC from GitHub!
Adding Networks¶
This guide will explain how to add and configure IRC networks with the Burd IRC client. It will also explain how to add a ZNC connection.
Adding a network¶
Lets get started!
Step One: Open Burd IRC¶
Open Burd IRC and click the New button in the bottom left corner. Then click the text that says “Create a new network…” Then a tab should appear that looks like this.
Step Two: Enter General Information¶
Most of the information here is simple and I do not need to explain. Such as nick name, alt. nick, user name (your IRC ident), and real name.
Step Three: Server Information¶
Next enter the information/connection information for the IRC network you would like to connect to. Such as the network name, host, port, etc.
Most of this information is pretty simple and I will not explain it.
Note
You MUST check off Use SSL with this server if you want to use SSL to connect to IRC.
Step Four: Login Method/Authentication¶
This section is where you setup NickServ, SASL, server password, or no authentication.
None¶
Check off the None option to not use any authentication or login methods.
NickServ¶
To just use ordinary NickServ authentication check off the NickServ option and then type in your NickServ password in the Password box.
Server Password¶
To connect to a passworded IRC network check off the Server Password option and type in the network’s password in the Password box.
SASL Plain Authentication¶
To identify to NickServ via SASL authentication check off the SASL Plain option. Then enter an username to identify to in the User box. Then for the password box enter your NickServ password.
Step Five: On-Connect Commands¶
You can enter on-connect commands such as JOIN #examplechannel so that is will perform the commands specified on connect without you having to manually type it in after connected to the IRC network. You can enter one or more connect commands by separating the commands with commas. Escaped commas are also accepted.
You can either have one command:
Or as many as you like by typing them like this:
Step Six: Click Save¶
Then click save and you are finished!
Connecting to ZNC with Burd¶
This section will explain how to add a ZNC connection to Burd IRC so you can use Burd IRC and ZNC.
Tip
If you need ZNC related help we suggest you visit the ZNC Wiki. Or visit #znc on the Freenode IRC network. Burd IRC is not responsible for any ZNC issues you may have.
Step One: Add a new network¶
Start by going and opening up the add network page.
Step Two: Enter Information¶
What you enter for the user information when on the new network page doesn’t matter. (nick, alt nick, etc) You can type anything in and it will not affect your ZNC connection.
Step Three: Enter ZNC Connection Information¶
The next step is to enter the network connection information.
Enter the network name.
Tip
The network name option when adding a network is not required. But it is extremely helpful for people who use ZNC and have many networks. It will display the name you supplied when adding the network in the list of connections.
The server hostname will be the IP adress or hostname of the server ZNC is running on.
Now enter the port for which ZNC is listening on.
Now check off options such as automatically reconnect, connnect on startup, and if Burd should use SSL to connect to the ZNC.
Note
Remember, you MUST check off Use SSL with this server if the port you supplied is an SSL port.
Step Four: Login Method¶
The login method you need to use to connect to a ZNC using Burd is the Server password method.
Start by selecting Server password as your login method.
Then a box to enter your password in will come up under Login Information.
The way you should enter your password into the password box is: zncusername/network:zncpassword
If you only have one network on your ZNC you can enter into the password box: zncusername:zncpassword
ZNC Username - The username you would use to login to ZNC and the ZNC webadmin.
Network - If you have more than one network on your ZNC, you will put the name of the network you would like ZNC to connect to. For example, if I want ZNC to connect to Freenode I would put: zncusername/Freenode:zncpassword
ZNC Password - The password you would use to login to ZNC and the ZNC webadmin.
Step Five: Save the network and connect¶
Once you have entered all the information required, just save the network and connect to it. And now you are using a ZNC connection with the Burd IRC client!
Updating Burd IRC¶
It is important to always update any software. This includes Burd IRC of course! It is very very very simple to update the Burd IRC client. Not to mention you get all the new features new versions sometimes include.
Method 1: How to update Burd IRC¶
This page will explain the simple steps to update Burd IRC!
Step One: Open Burd IRC¶
Once Burd IRC is open if there is an new update a pop message will appear once Burd IRC is open. It will say there is an new update is available. It will have the option to update now or cancel and update later.
Step Two: Click Update¶
Now just click update and wait! It should take less than 20 seconds for Burd IRC to update.
To confirm that Burd IRC did indeed update, go to Settings > About and check to see if it updated to the new version!
Warning
If the Burd IRC client did NOT update please come visit us on our IRC Channel on Freenode and let us know! (Channel: #burdirc)
Method 2: How to update Burd IRC¶
Step One: Type /update¶
Type /update and Burd IRC will update.
Warning
If the Burd IRC client did NOT update please come visit us on our IRC Channel on Freenode and let us know! (Channel: #burdirc)
File Uploading¶
Burd IRC uses https://arxius.io for media and file uploads. As of Burd IRC 0.6.0 you can now use a custom site to upload media via Burd IRC.
Uploading Via Arxius¶
How To Upload¶
First Method: You can upload media while using Burd by either dragging and dropping the file of which you want to upload in the Burd IRC window.
Second Method: Or you can click the emoji button at the bottom right side of the screen and click upload file. Then find the file you want to upload and upload it.
Arxius API Key¶
If you do not have an arxius account and do not have an API key set in the Burd settings your files will be uploaded as an anonymous user. This also means you are unable to delete the file, change the title of the post, or change the description of the post.
If you have an arxius account you are able to obtain an API key so that your files are uploaded directly to your arxius account.
How To Obtain An API Key¶
Step One: Open your web browser and go to https://arxius.io and make sure you are logged into your account.
Step Two: Open the JS console in your web browser and it should generate an API key.
Step Three: Copy and paste the API key into the Arxius API key input section in the Burd settings.
Warning
Arxius is an image uploading service owned and operated by Jordan Koch. ANY type of illegal content uploaded to this website will be reported to authorites.
Uploading Via Custom Site¶
As of Burd IRC version 0.6.0 you can now use a custom site or service to upload content via Burd.
more coming soon
Themes¶
Burd only offers a small amount of themes that come pre-installed. Currently Burd IRC themes are designed with css.
The public is free fo make themes for Burd IRC. There is a github repo that you can request for your theme to be added to if you wish.
About Burd IRC¶
Burd IRC is an IRC client that is currently supported on Windows only. Burd IRC is being created and being ran using Electron. We are releasing very early public betas.
Features and Key Points¶
- SASL - Burd IRC currently only supports SASL Plain. We are currently working on adding more SASL authentication mechanisms such as external.
- SSL/TLS - Burd IRC supports connecting to IRC networks using SSL/TLS. It was not working in previous public betas of Burd IRC but should be working on the latest version.
- Server passwords - Burd IRC supports the ability to connect to passworded servers. Which also enables the capability of logging into ZNC without having to manually /quote PASS. Easier ZNC setup such as being able to enter ZNC username, password, and the network without having to type in the whole PASS command as a server password will be a possibility for a later version.
- File Uploads (via arxius.io) - Burd IRC supports file uploads via arxius.io.
- Inline Media - Burd IRC supports inline media.
Future Plans¶
Burd IRC is currently a very simple IRC client because of the fact that it is a very new IRC client. So of course the future holds much potential for Burd.
- macOS Version - A macOS version of Burd IRC will come in the future! Stay tuned for that!
- SASL External - SASL external authentication is most likely going to be added in some future version of Burd IRC. This will open up a new set of capabilities and things you can do.
- More Customization - More customization features.
Contributing¶
There are many ways you can help contribute to the Burd IRC Client project. We are looking for people to contribute to the project by doing things such as giving ideas for new features, ideas to improve current features, and ways to improve the client overall.
How you can contribute.¶
Here are the main method(s) that you can use to help contribute to the Burd IRC project.
GitHub¶
You can contribute to Burd IRC by creating issues on our GitHub repo. We have issue templates for feature requests/suggestions and an issue template for bug/issue reports. You can report issues you are experiencing by submitting an issue to our GitHub repo. You can also submit your feature requests and suggestions as an issue on our GitHub repo.
IRC channel¶
The best way you can contribute to the Burd IRC client project is to come to our IRC channel and give us tips, opinions, things we can make better, tell us about bugs, etc.
Join our IRC channel:
chat.freenode.net Ports: SSL: 6697 Non-SSL: 6667 Channel: #burdirc
Team and Contributors¶
Burd IRC is currently not known by many people at all. We are always looking for people to help us make Burd IRC better, tell people about Burd IRC, and contribute in general. Here are some contributors.
Development Team¶
Burd IRC has two developers. They are building Burd IRC and everything associated with it. They are doing many tasks.
- Developing Burd IRC (coding, support, staff, etc)
- Support - Helping users with issues they may overcome.
- Staff - They operate and manage the IRC channel.
Beta Testing and Contribution¶
The beta testers of course test betas, but also make other contributions by testing betas, such as issues they find, suggestions, ideas. Some beta testers even provide services for Burd IRC to help make it better.
- Beta Testing - Finding issues, bugs, suggestions, etc.
- Other Contributions
Members¶
Community Contributions¶
People from the community make contributions. They give ideas, suggestions, bugs, issues, etc. We greatly appreciate any and all feedback and support from the community. :)
IRC Channel Guidelines¶
User guidelines, rules, and expectations for our IRC channel. If you violate these rules action will be taken such as a kick, quiet, timed ban, or even a permanent ban from the channel. Depending on the severity of the situation you could recieve a network ban.
General Expectations¶
General Expectations that you should already know.
- Spamming/Flooding
- We will not tolerate ANY spamming. We have a bot present in the channel that handles flooding.
- Cursing
- Cursing is allowed. We please ask that you keep cursing at a minimum. If you overuse curse words or if you intentionally use curse words to insult other users you will be banned.
- Ban Evasion
- We will not tolerate ban evasion. If you have any questions regarding why you are banned we suggest you join #burdirc-help and ask any questions there.
- Racism/Hate Speech
- Racism/hate speech is NOT TOLERATED. This means any type of racist words, statements, or hate speech. You should know what you should say and what you should not. We have a bot present in the channel that will unfortunately only kick, and not ban users for using the prohibited words. Therefore operators will enforce the rule by setting a ban.
- Inappropriate Content
- Inappropriate content is NOT tolerated whatsoever. This means that any content such as pornography, NSFW content, links to innapropriate sites/content, etc.
- Harassment
- We will NOT tolerate the harassment of other users.
- Threats
- Making ANY type of threat about anything or anyone is NOT TOLERATED WHATSOEVER.
- Illegal Content/Activities
- Distribution or encouraging illegal content is against channel guidelines. The discussion or encouragement of illegal activites is also against channel guidelines. If you break this rule it is likely that freenode staff or even law enforcement will become involved.
- Freenode Policies
- Basically do NOT do anything that would get you a network ban, or anything that is against the Freenode Policies.
Contributing¶
The IRC channel is a place were we can collaborate, discuss ideas, and overall stay on topic, the topic being the Burd IRC client project. Here are expectations for the type of discussions, conversations, and talk that should take place in the channel.
- Stay On Topic
- Our channel is not a social channel. The channels purpose is for Burd IRC discussion, not for talking about what you are doing tonight, what games you are playing, etc. We ask you keep the discussion on topic.
- Help Don’t Hinder
- Do not come in the channel to talk about how much better another client is, and about how Burd IRC sucks. We ask for helpful tips, and postive feedback. (Such as things that need improving, things you like, feature reccomendations)
- Asking for help
- Give a detailed explanation of the issue you are having. We also ask that you please be patient. We all have a life outside of IRC. If you do not have time to wait consider submitting an issue on our GitHub repo.
Help Channel¶
If you have any questions regarding the operation of our IRC channel please join #burdirc-help and ask us. This channel is not for questions related to the Burd IRC client it is for questions regarding issues in our IRC channel such as questions about a ban, users breaking rules, etc.
IRC Channel Information¶
Tip
We will not give cloaks out to ANYONE. We will only provide cloaks to TRUSTED contributors. So do not bother asking for a cloak.
Here is a list of the staff. If you have any concerns feel free to give one of us a shout in our IRC channel. (Except BurdIRC thats a bot :P)
Warning
Please remember anyone without a burdirc/* cloak is most likely NOT affiliated with the Burd IRC project.
Nick | Role |
---|---|
duckgoose | Channel Founder |
DetectiveTaco | Channel Founder |
eskimo | Channel Operator |
BurdIRC | Bot |
GitHub - Issue Submissions¶
This guide will explain how to properly submit an issue on our GitHub repository.
Bug/Issue Report¶
There are a few rules and guidelines when submitting an issue on the GitHub repo regarding bugs, issues, etc.
These are a few things we ask you keep in mind when submitting an issue:
- Provide a detailed description of the issue.
- Include what version of Burd and what OS
- Tell us what you were doing or trying to do when you experienced the issue.
- Provide any media if possible. (Screenshots, videos, etc)
- Check to see if someone already has or had submittted an issue for the issue you are having. You may be able to get more information or the solution to your issue by looking for another previously submitted issue.
- Make an effort to use proper spelling and grammar as this helps us understand what your issue is
- Keep any innapropriate content/language out of the issue submissions. Also keep any off-topic conversation out as well.
Feature Requests¶
You can also make issue submissions regarding feature requests. Here are a few tips and guidelines to keep in mind when submitting a feature request:
- Give a description of what feature you would like added.
Release Changelog/Notes¶
Release notes and changes.
PAGE OUT OF DATE.
I havent really updated this?
Stable Releases¶
Version 0.6.0 (v0.6.0-pre.3)¶
Date: | September 27th, 2018 |
---|
- Updated File Uploading. Now you can upload from a custom site.
- Messages that were not being sent to console when supposed to is now fixed.
- ZNC playback message count showing beside channel in list now
- Added docs URL in about section in settings.
- When you drag an image from a web browser into the Burd IRC window it will no longer ask to redirect you to the URL of the image.
- Modified channel content page.
- User list bug were it would show everyone’s nick multiple times was fixed.
- Other bug fixes and things added.
Version 0.5.9¶
Date: | September 20th, 2018 |
---|
- Network console is no longer a separate tab in the network sidebar. It can now be accessed by clicking on the network name.
Version 0.5.8¶
Date: | September 15th, 2018 |
---|
- Added parsing in channel user list.
- Changed user prefix icons in channel user list.
- Commands that required extra parameters do not anymore.
- Changed nick brackets.
- Bug fixes