cinny/owl/README.md

Owl Folder

owl.cx employs it's own cinny fork.

this one should slowly introduce changes and features that are useful for a homeserver, and go even further into the direction of replacing teamspeak or discord.

it does not try to keep up the typical matrix approach to have overengineered decisions in the chat, or avoid all kinds of exploits that are dangerous for federated servers, but less impactful for a single-server-instance.

It still tries to respect matrix as a tool, that can do all these things.

In this owl folder should go all documents we produce for this Endeavour.

Goals

• Find a way to build extensions that survive upstream merges best. This means, reduce contact point, create own files, even be in own folder if possible. This needs a thorough scan of the codebase.
• We will try to integrate comms project at some point. but this is a separate task, not needed yet. It will bring voice server to the rooms. comms uses a wasm system.
• Try to find out how much we can change behaviour of the page with the themes (skins) only. Some small silly things, like that reacting with a new emoji on a post should not be on the left side of a message, where currently it is embedded in a popup.
• Find out how we can set that Twitter Emojis are standard - system emojis on windows are terrible.
• Find out how we can set a theme by default for new users.
• img tags in messages should be rendered, without requiring them to be on a local cache. We do not need to secure against identification attacks.
• youtube links should create embedded players (if enabled).
• 9gag links with videos should allow them to be played if possible on demand.

Commit Messages

• All Commits for OWL changes start with the Owl Emoji 🦉
• I do most commits as user

Code Guidelines

• This Repository follows the official cinny repo, but represents a custom modification.
• This means we have to keep Upstream Codebase mergable easy
• This means: /src/owl/ is the local override folder, longer implementations and definitions go
• Only required wirings, imports or unavoidable modifications should be in the main source code.
• Learn from owl commits