{"id":27645788,"url":"https://github.com/tgiachi/orion","last_synced_at":"2025-08-27T22:15:58.549Z","repository":{"id":288106233,"uuid":"966852934","full_name":"tgiachi/orion","owner":"tgiachi","description":"Orion: A modern, multi-transport IRC server implemented in C#. Features secure connections via TCP, SSL/TLS, and WebSockets with a modular architecture.","archived":false,"fork":false,"pushed_at":"2025-08-11T21:44:52.000Z","size":1350,"stargazers_count":2,"open_issues_count":11,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-08-17T21:28:01.301Z","etag":null,"topics":["hobby-project","irc","irc-protocol","irc-server","ircv3","networking"],"latest_commit_sha":null,"homepage":"","language":"C#","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tgiachi.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-15T14:51:27.000Z","updated_at":"2025-07-26T22:23:41.000Z","dependencies_parsed_at":"2025-04-24T01:12:56.086Z","dependency_job_id":"a00185ac-c6e2-42a6-9d8f-01fb23a60fcc","html_url":"https://github.com/tgiachi/orion","commit_stats":null,"previous_names":["tgiachi/orion"],"tags_count":89,"template":false,"template_full_name":null,"purl":"pkg:github/tgiachi/orion","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgiachi%2Forion","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgiachi%2Forion/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgiachi%2Forion/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgiachi%2Forion/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tgiachi","download_url":"https://codeload.github.com/tgiachi/orion/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tgiachi%2Forion/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272387899,"owners_count":24925976,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-27T02:00:09.397Z","response_time":76,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hobby-project","irc","irc-protocol","irc-server","ircv3","networking"],"created_at":"2025-04-24T01:12:43.454Z","updated_at":"2025-08-27T22:15:58.460Z","avatar_url":"https://github.com/tgiachi.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Orion IRC Server\n\n![Version](https://img.shields.io/badge/version-0.1.0-blue)\n![License](https://img.shields.io/badge/license-MIT-green)\n![.NET](https://img.shields.io/badge/.NET-9.0-purple)\n\n\u003e IRC is not dead, long live IRC!\n\n![Orion Logo](assets/orion_logo.png)\n\u003e Orion (Orione in italiano) is my cat and this project is dedicated to him.\n\n\n\n[![Docker Image](https://img.shields.io/docker/v/tgiachi/orionircserver?label=docker\u0026sort=date)](https://hub.docker.com/r/tgiachi/orionirc-server)\n\nOrion is a modern, scalable IRC server built with .NET 9.0, designed to provide robust functionality while maintaining performance and flexibility.\n\n## 🌟 Features\n\n- 🔒 Secure connections with SSL/TLS support\n- 🌐 IPv4 and IPv6 support\n- 🛠️ Completely modular and extensible architecture\n- 📝 Scripting support via JavaScript engine (Jint)\n- 📊 Performance metrics and diagnostics\n- 📜 Text templating with Scriban\n- 🧩 Plugin system\n- 🐳 Docker support\n- 🌉 Planning to create bridges for Discord, Matrix, and other platforms\n\n## 📋 Project Structure\n\nOrion is built as a collection of modular components:\n\n- **Orion.Core**: Base utilities, extensions and common functionality\n- **Orion.Core.Server**: Server-side core functionality\n- **Orion.Core.Server.Web**: Web API and HTTP interface\n- **Orion.Irc.Core**: IRC protocol implementation\n- **Orion.Network.Core**: Networking abstractions\n- **Orion.Network.Tcp**: TCP implementation for network transports\n- **Orion.Server**: Main application entry point\n\n## 🔧 Configuration\n\nOrion uses YAML for configuration. On first run, a default configuration file is created at the specified path. Key configuration sections include:\n\n```yaml\n# Server identification\nserver:\n  id: auto-generated\n  host: irc.orion.io\n  network: OrionNet\n  description: Orion IRC server\n  admin:\n    name: Orion Admin\n    email: admin@orion.io\n    nickname: OrionAdmin\n\n# Network settings\nnetwork:\n  ssl:\n    certificate_path: path/to/certificate\n    password: certificate_password\n  binds:\n    - host: 0.0.0.0\n      ports: 6660-6669,6670\n      network_type: clients\n      secure: false\n      use_web_socket: false\n\n# Web HTTP API\nweb_http:\n  is_enabled: true\n  listen_address: 0.0.0.0\n  listen_port: 23021\n  jwt_auth:\n    issuer: Orion\n    audience: Orion\n    expiration_in_minutes: 44640  # 31 days\n    refresh_token_expiry_days: 1\n```\n\n## 🚀 Getting Started\n\n### Prerequisites\n\n- .NET 9.0 SDK\n- SSL certificate (optional, for secure connections)\n\n### Installation\n\n1. Clone the repository:\n   ```bash\n   git clone https://github.com/tgiachi/orion.git\n   cd orion\n   ```\n\n### Docker\n\nYou can run Orion using Docker:\n\n```bash\ndocker pull tgiachi/orionirc-server\ndocker run -p 6667:6667 -p 23021:23021 tgiachi/orionirc-server\n```\n\n2. Build the solution:\n   ```bash\n   dotnet build\n   ```\n\n3. Run the server:\n   ```bash\n   dotnet run --project src/Orion.Server\n   ```\n\n#### Command Line Options\n\n```\n-c, --config           Path to configuration file (default: orion.yml)\n-r, --root-directory   Root directory for the server\n-s, --show-header      Show header in console (default: true)\n-l, --log-level        Log level (Trace, Debug, Information, Warning, Error)\n-v, --verbose          Enable verbose output\n```\n\n## 📝 Scripting\n\nOrion includes a JavaScript engine that allows you to extend functionality through scripts. Scripts are stored in the `scripts` directory and can use the modules registered with the server.\n\nExample:\n\n```javascript\n// Access the logger module\nlogger.info(\"Server is running!\");\n\n// Define event handlers\nfunction onStarted() {\n    logger.info(\"Server has started successfully\");\n    // Custom initialization code here\n}\n```\n\nThe script engine automatically generates TypeScript definitions (`index.d.ts`) to provide code completion and documentation for available modules and functions.\n\n## 👷 Development\n\n### Adding New IRC Commands\n\nTo implement a new IRC command:\n\n1. Create a class that inherits from `BaseIrcCommand`\n2. Implement the `Parse` and `Write` methods\n3. Register the command with the `IrcCommandParser` service\n\nExample:\n\n```csharp\npublic class MyCommand : BaseIrcCommand\n{\n    public MyCommand() : base(\"MYCMD\") { }\n\n    public override void Parse(string line)\n    {\n        // Parse command logic\n    }\n\n    public override string Write()\n    {\n        // Serialize command logic\n        return $\"MYCMD :parameters\";\n    }\n}\n```\n\n### Creating Command Handlers\n\nTo handle IRC commands:\n\n1. Create a class that inherits from `BaseIrcCommandListener`\n2. Implement the `IIrcCommandHandler\u003cT\u003e` interface\n3. Register the handler for specific server network types\n\nExample:\n\n```csharp\npublic class MyCommandHandler : BaseIrcCommandListener, IIrcCommandHandler\u003cMyCommand\u003e\n{\n    public MyCommandHandler(\n        ILogger\u003cBaseIrcCommandListener\u003e logger,\n        IIrcCommandService ircCommandService,\n        IHyperPostmanService postmanService,\n        IIrcSessionService sessionService\n    ) : base(logger, ircCommandService, postmanService, sessionService)\n    {\n        RegisterCommandHandler\u003cMyCommand\u003e(this, ServerNetworkType.Clients);\n    }\n\n    public async Task OnCommandReceivedAsync(\n        IrcUserSession session,\n        ServerNetworkType serverNetworkType,\n        MyCommand command\n    )\n    {\n        // Handle the command\n    }\n}\n```\n\n\n\n## 🤝 Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n1. Fork the repository\n2. Create your feature branch (`git checkout -b feature/amazing-feature`)\n3. Commit your changes (`git commit -m 'Add some amazing feature'`)\n4. Push to the branch (`git push origin feature/amazing-feature`)\n5. Open a Pull Request\n\n## 📄 License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n\n## 📬 Contact\n\nProject Link: [https://github.com/tgiachi/orion](https://github.com/tgiachi/orion)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftgiachi%2Forion","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftgiachi%2Forion","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftgiachi%2Forion/lists"}