|
1 | 1 | # Ossum Open Source Software |
2 | 2 |
|
3 | | -In this section you will find open source software released by Ossum Inc. Feel free to try it out! There is no charge |
4 | | -for using this Ossum software! |
| 3 | +Ossum Inc. provides open source tools for working with the RIDDL language. |
| 4 | +All software is free to use under the Apache License 2.0. |
5 | 5 |
|
6 | | -Here are the open source projects: |
| 6 | +## IDE Extensions |
7 | 7 |
|
8 | | -* [RIDDL](./riddl/index.md) |
9 | | -* [VS Code Extension For RIDDL](./vscode-extension/index.md) |
10 | | -* [IntelliJ IDEA Plugin](./intellij-plugin/index.md) |
| 8 | +### [IntelliJ IDEA Plugin](./intellij-plugin/index.md) |
| 9 | + |
| 10 | +RIDDL language support for JetBrains IntelliJ IDEA, including: |
| 11 | + |
| 12 | +- Syntax highlighting with customizable colors |
| 13 | +- Real-time validation and error detection |
| 14 | +- Integrated RIDDL tool window |
| 15 | +- Clickable error navigation |
| 16 | + |
| 17 | +**Status**: Beta - [Download](https://github.com/ossuminc/riddl-idea-plugin/releases) |
| 18 | + |
| 19 | +### [VS Code Extension](./vscode-extension/index.md) |
| 20 | + |
| 21 | +RIDDL language support for Visual Studio Code, including: |
| 22 | + |
| 23 | +- Syntax highlighting with semantic tokens |
| 24 | +- IntelliSense code completion (50+ keywords) |
| 25 | +- Real-time diagnostics |
| 26 | +- Go to Definition and Find References |
| 27 | +- Hover documentation |
| 28 | + |
| 29 | +**Status**: Beta - [Download](https://github.com/ossuminc/riddl-vscode/releases) |
| 30 | + |
| 31 | +--- |
| 32 | + |
| 33 | +## Writing RIDDL |
| 34 | + |
| 35 | +### [Authoring RIDDL Sources](./authoring-riddl.md) |
| 36 | + |
| 37 | +A comprehensive guide to writing effective RIDDL source files, covering: |
| 38 | + |
| 39 | +- File organization and includes |
| 40 | +- Adding metadata with the `with` clause |
| 41 | +- Type definitions and references |
| 42 | +- Commands, events, queries, and results |
| 43 | +- Entity design patterns |
| 44 | +- Handler statements |
| 45 | +- Common patterns and best practices |
| 46 | + |
| 47 | +This guide applies to any IDE or editor. |
11 | 48 |
|
12 | 49 | --- |
13 | 50 |
|
14 | | -If you have any questions or need assistance, please contact our support team at support@ossuminc.com |
| 51 | +## AI-Assisted Modeling |
| 52 | + |
| 53 | +### [RIDDL MCP Server](../MCP/index.md) |
| 54 | + |
| 55 | +Connect AI assistants to the RIDDL MCP Server for intelligent modeling |
| 56 | +assistance: |
| 57 | + |
| 58 | +- Validate RIDDL code with detailed error messages |
| 59 | +- Check model completeness and get suggestions |
| 60 | +- Convert natural language to RIDDL structures |
| 61 | +- Get explanations for validation errors |
| 62 | + |
| 63 | +Supports: Claude Desktop, Claude Code, Gemini CLI, VS Code Copilot, |
| 64 | +IntelliJ AI Assistant, and IntelliJ Junie. |
| 65 | + |
| 66 | +--- |
| 67 | + |
| 68 | +## Getting Started |
| 69 | + |
| 70 | +1. **Install an IDE extension** for your preferred editor |
| 71 | +2. **Read the authoring guide** to learn RIDDL best practices |
| 72 | +3. **Connect the MCP server** for AI-assisted modeling (optional) |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## Support |
| 77 | + |
| 78 | +If you have questions or need assistance: |
15 | 79 |
|
16 | | -If you are interested in contributing to our open source projects, please visit our GitHub organization at |
17 | | -https://github.com/ossuminc. |
| 80 | +- **Email**: support@ossuminc.com |
| 81 | +- **GitHub**: [github.com/ossuminc](https://github.com/ossuminc) |
18 | 82 |
|
| 83 | +## Contributing |
19 | 84 |
|
| 85 | +We welcome contributions to all open source projects. Visit the GitHub |
| 86 | +repositories linked above to report issues, suggest features, or submit |
| 87 | +pull requests. |
0 commit comments