code multiplexer -- fast, safe, collaborative editor plugin ecosystem
Find a file
alemi d963da6583
ci: "fix" tests
i dont know how to do this with just one task: basically when building
lua feature on mac i need to change the build command. so i split off
the lua build task. its annoying but ehh
2024-09-17 20:34:40 +02:00
.github/workflows ci: "fix" tests 2024-09-17 20:34:40 +02:00
dist feat(lua): released on LuaRocks 2024-09-17 19:33:27 +02:00
src feat(lua): pass logs via callback channel, fix hints 2024-09-17 18:53:52 +02:00
.editorconfig fix: editorconfig for yaml 2023-08-17 22:51:04 +02:00
.gitignore feat(python): build wheels with manual specified __init__.py 2024-09-10 19:09:54 +02:00
.rustfmt.toml build: initial commit with tonic stubs 2022-07-10 19:01:56 +02:00
build.rs chore: rename feature to py for consistency 2024-09-13 22:21:53 +02:00
Cargo.lock chore: bump beta version, publish 2024-09-11 18:11:20 +02:00
Cargo.toml feat(lua): alternative getters, annotations 2024-09-16 18:24:24 +02:00
LICENSE docs: license 2024-09-05 03:08:50 +02:00
README.md feat(lua): released on LuaRocks 2024-09-17 19:33:27 +02:00

codemp

Actions Status docs.rs Status Gitter Chat Crates.io Version NPM Version PyPI Version LuaRocks Version

codemp is a collaborative text editing solution to work remotely.

It seamlessly integrates in your editor providing remote cursors and instant text synchronization, as well as a remote virtual workspace for you and your team.

codemp is build with state-of-the-art CRDT technology, guaranteeing eventual consistency.

This means that everyone is guaranteed to converge to a consistent state once all changes are received no matter the order or the timing due to unreliable networks or constrained resources. And similarly, your changes will always carry their original intention. On top of this baseline, codemp's protocol is optimized for speed and low network footprint, meaning even slow connections can provide stable real-time editing.

The full documentation is available on docs.rs.

Usage

codemp is primarily used as a plugin in your editor of choice.

Installation

Important

The editor plugins are in active development. Expect frequent changes.

codemp is available as a plugin for a growing number of text editors. Currently we support:

Registration

The codemp protocol is openly available and servers may be freely developed with it.

A reference instance is provided by hexed.technology at code.mp. You may create an account for it here. During the initial closed beta, registrations will require an invite code. Get in contact if interested.

An open beta is going to follow with free access to a single workspace per user. After such period, code.mp will switch to a subscription-based model.

Development

This is the main client library for codemp. It provides a batteries-included fully-featured Client, managed by the library itself, and exposes a number of functions to interact with it. The host program can obtain a Client handle by connecting, and from that reference can retrieve every other necessary component.

codemp is primarily a rlib and can be used as such, but is also available in other languages via FFI.

Adding a dependency on codemp is easy:

From Rust

Just cargo add codemp and check the docs for some examples.

From supported languages

We provide first-class bindings for:

  • JavaScript available from npm as codemp
  • Python available from PyPI as codemp
  • Lua available from LuaRocks as codemp
  • Java available on MavenCentral SOON

As a design philosophy, our binding APIs attempt to perfectly mimic their Rust counterparts, so the main documentation can still be referenced as source of truth. Refer to specific language documentation for specifics, differences and quirks.

From other languages

Important

The common C bindings are not available yet!

Any other language with C FFI capabilities will be able to use codemp via its bare C bindings. This may be more complex and may require wrapping the native calls underneath.

Get in Touch

We love to hear back from users! Be it to give feedback, propose new features or highlight bugs, don't hesitate to reach out!

Contacts

We have a public Gitter room available on gitter.im/hexedtech/codemp. It's possible to freely browse the room history, but to send new messages it will be necessary to sign in with your GitHub account.

If you have a Matrix account, you can join the gitter room directly at #hexedtech_codemp:gitter.im

Contributing

If you find bugs or would like to see new features implemented, be sure to open an issue on this repository.

In case you wish to contribute code, that's great! We love external contributions, feel free to open a PR!