Documentation

[TsotneMikadze]

Hello,
I am working on a project involving diagrams and I found that your project is very useful for me. Can I use your project’s code? Also, is there more detailed documentation available about the code?

[vhemery]

Hello,
You can use EMF Cloud's code as long as you respect the license.
https://github.com/eclipse-emfcloud/emfcloud?tab=License-1-ov-file#readme

Since you are asking, I guess you must not be all too familiar with open source licenses, so I'll give you a few extra details.
Please note that I am not a lawyer and this is not in any way legal advice.
(I am not liable for any misinterpretation or misuse you may be doing)

First thing, you must comply with open source licenses as soon as you redistribute the software in any form. That means if you are running it on your machine for personal use and not sharing anything with anyone, there is no constraint at all.

Whenever you share anything (code, binary, service), you may choose at your convenience between EPL v2 license and MIT license.

In a few (very roughly summarized) words, the EPL v2 says: you can embed the tech in a proprietary software. But if you modify/patch the tech (derived work), your modifications must be distributed in the same EPL v2 licence to your recipients. The same rule applies if you copy-paste part of the code to your own project (which must then be compatible with EPL v2, so most probably EPL v2-licensed).

In a few (very roughly summarized) words, the MIT says: you can modify and reuse whatever you want, but tell your recipient what you have modified and include a copy of the MIT licence. (explain it typically in a LICENSE.txt file)

For entry pointers, you can look at the README : https://github.com/eclipse-emfcloud/emfcloud/blob/master/README.md
It will give you usefull links to the website and discussions pages and support options.

If you are manly interested in diagrams, you may probably want to choose the Langium-Based DSL Approach rather than the Model Hub Approach, which is more specifically EMF-oriented.

[TsotneMikadze]

Hello, this is a university project for me, and I also have a license for Eclipse 2.0, so I believe I have all the required licenses to work on what I need.
For this project, I need an Ecore editor, a Reaction editor, and Text LSP.
Could you suggest which project would be better for me to use, and where I can find detailed documentation?

[martin-fleck-at]

So if you require a textual syntax as basis for your language, then you require a language server as you mentioned. If you want to implement that server in Node, I'd suggest you definitely look into the Langium-based approach where Langium serves as a basis to define your grammar and implement the language server and shows how you can integrate it with GLSP for the graphical representation. A few existing projects come to mind which you may find helpful:

• CrossModel: A platform for data modeling and model-driven data engineering that follows the Node-based approach by combining Langium (language server), GLSP (graphical server and client-side framework), and Theia (as client-side platform).
• BigUML: An open-source UML modeling tool for VS Code supporting hybrid, textual- and graphical editing, multiple notations, and SQL code generation. It uses a Java-based approach using EMF Ecore (which they do not recommend using anymore as they are planning to switch to a Node-based server) that is available as a VS Code extension.
• BigER: A project from the same group for ER modeling with an explicit Java-based language server for a cleaner syntax.

Please make sure to check the license of the individual projects before using any of their code.