Skip to content

Latest commit

 

History

History
52 lines (43 loc) · 2.65 KB

README.md

File metadata and controls

52 lines (43 loc) · 2.65 KB

OpenIRCd

OpenIRCd is an easy-to-use non-blocking high performance IRC server written in Java.

A screenshot of OpenIRCd

This is a work in progress and acts as an example of how to use the Socket-Server library.

💡 Requirements

  • Java Runtime 1.8 or higher

⚙️ Start IRC Server

java -jar OpenIRCd-v0.1.0.jar
  • This will create the default config under ./config.ini
  • Adjust the configuration as needed, then restart the server.

💻 CLI / Server Commands

  • You can execute commands through the CLI by executing it directly as a program argument
    • This will save the database to disk once the command has finished executing.
  • Or, you can execute commands from the terminal just by executing it normally and typing into the console.
  • Type help to get started.
  • To give operator priviliges just type op add <nick> - Oppers have to setup and verify with nickserv.
  • To list all languages type lang list, then to set the language type lang set <language>.

🌐 Translations

  • Translations are automatically selected with your system language, to define a specific translation go into the config.ini and edit translation=<language>
  • Fully translated into English, Arabic, Croatian, Czech, Bulgarian, Danish, Estonian, Farsi, Finnish, French, German, Georgian, Greek, Hausa, Hebrew, Hungarian, Indonesian, Italian, Japanese, Lativan, Lithuanian, Malay, Mandarin, Nederlands, Norwegian, Polish, Portuguese, Romanian, Russian, Slovak, Slovenian, Spanish, Serbian, Swahili, Swedish, Turkish, Ukrainian & Vietnamese.

🔑 Implementation Progress

  • IRC v1 is the target but certain IRC v3 extensions are planned to be supported (SASL)
  • Configuration is done
  • CLI is done
  • Protocol Decoding / Encoding is done
  • Core API is started
  • Object Serialization is started / partially finished
  • Channel Functionality is done, missing permissions
  • Resource Limiter is done
  • NickServ / Authorization is started
  • User Modes not started
  • Channel Modes not started
  • Plugins / Event System is done but external plugins are not finished

📚 Resources

👨‍💻 Disclaimer

  • This is a work in progress.