Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions compare/benchmarks.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ The data below is the average time taken to bridge a message to one server (Sing
| Category | Unifier | Tunnels.gg | ComBot | Silly Chat | Bolt | InterChat |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------- |
| Single | **<Tooltip tip="Average time taken to bridge messages.">173.67</Tooltip>**<br /><Tooltip tip="Uncertainty (calculated using (max-min)/2). Lower uncertainties suggest better consistency across servers.">±21</Tooltip><br /><br />B: **<Tooltip tip="Shortest time taken to bridge one message to a connected channel, not shortest average time taken for each trial.">157</Tooltip>**<br />W: **<Tooltip tip="Longest time taken to bridge one message to a connected channel, not longest average time taken for each trial.">199</Tooltip>** | **310.67**<br />±11<br /><br />B: **302**<br />W: **324** | **158.33 👑**<br />±10<br /><br />B: **149**<br />W: **169** | **369.00**<br />±10.5<br /><br />B: **356**<br />W: **369** | **339.00**<br />±23.5<br /><br />B: **322**<br />W: **369** | **565.33**<br />±26<br /><br />B: **537**<br />W: **589** |
| Multi (3 servers) | **212.00**<br />±75<br /><br />B: **140**<br />W: **<Tooltip tip="For some bots, the worst multi-bridge performance may be significantly higher than the best performance and average performance, as they bridge to servers sequentially rather than concurrently.">290</Tooltip>** | **462.67**<br />±180<br /><br />B: **312**<br />W: **672** | **235.22**<br />±131.5<br /><br />B: **141**<br />W: **404** | **653.67**<br />±266<br /><br />B: **396**<br />W: **928** | **530.22**<br />±230.5<br /><br />B: **320**<br />W: **781** | **570.78**<br />±75.5<br /><br />B: **486**<br />W: **637** |
| Multi (3 servers) | **212.00 👑**<br />±75<br /><br />B: **140**<br />W: **<Tooltip tip="For some bots, the worst multi-bridge performance may be significantly higher than the best performance and average performance, as they bridge to servers sequentially rather than concurrently.">290</Tooltip>** | **462.67**<br />±180<br /><br />B: **312**<br />W: **672** | **235.22**<br />±131.5<br /><br />B: **141**<br />W: **404** | **653.67**<br />±266<br /><br />B: **396**<br />W: **928** | **530.22**<br />±230.5<br /><br />B: **320**<br />W: **781** | **570.78**<br />±75.5<br /><br />B: **486**<br />W: **637** |

(Note: you may need to scroll to see all entries.)

Expand All @@ -48,9 +48,9 @@ The averages were derived from the mean average of the three trials for each cat

We try to keep our data as consistent, accurate, and bias-free as possible, but there's still some things you probably want to know about this experiment.

- Unifier instance used for testing was hosted in **Canada**, while Bolt and Silly Chat instances used for testing were hosted in **Germany** due to compatibility issues with the former host. We do not know where the Tunnels.gg and Connections Bot instances were hosted in.
- As Tunnels.gg and Connections Bot are closed source, **we could not get access to private instances for testing**, so we had to use public instances.
- This means that our private instances were connected to much less servers than Tunnels.gg's and Connections Bot's public instances, which were each connected to thousands. However, both Tunnels.gg and Connections Bot were most likely running on hosts with much more resources than the host we used, since more resources would be required to keep up with a larger server count than just a dual-core 4GB RAM host. Therefore, we decided to not take the server count difference into account, as the resources difference would balance it out.
- The Unifier instance used for testing was hosted in **Canada**, while Bolt and Silly Chat instances used for testing were hosted in **Germany** due to compatibility issues with the former host. We do not know where the Tunnels.gg and Connections Bot instances were hosted in.
- Because Tunnels.gg and Connections Bot are closed source, **we could not get access to private instances for testing**, so we had to use public instances.
- This means that our private instances were connected to much less servers than Tunnels.gg's and Connections Bot's public instances, which were each connected to thousands. However, both Tunnels.gg and Connections Bot were most likely running on hosts with much more resources than the host we used, since more resources would be required to keep up with a larger server count than just a dual-core 4GB RAM host. Therefore, we decided to not take the server count difference into account, as the resources difference would balance it out.
- Although InterChat is open source, we could not self-host it due to lack of proper documentation for self hosting. Therefore, we decided to use the public instance instead.
- For some bots, we actually did more than three trials until we could get three trials that gave consistent data. This so we can measure what the bots are able to achieve on a consistent basis without giving any of them unfair bonuses or penalties for inconsistent performance.
- We wanted to test the bridging performance of files, but we decided to not do this as a fair testing environment was impossible. While Unifier relays replicas of files to servers, other bots we compared sent the attachment link instead. Testing the file bridging speed for bots that send attachment links would be the same as testing the text bridging performance again.
Expand Down
2 changes: 1 addition & 1 deletion compare/full-vs-micro.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ As Unifier Micro heavily cuts down on caching, it will use the CPU and network m
| <Tooltip tip="Ability to set a custom display name for Unifier without changing your actual display name or server nickname.">Nickname support</Tooltip> | ✅ | ❌ |
| <Tooltip tip="Ability to let server moderators block users or servers from bridging messages to their server.">User/server blocking</Tooltip> | ✅ | ✅ |
| <Tooltip tip="Ability to easily and discreetly report abusive messages to instance moderators.">Message reporting</Tooltip> | ✅ | ❌ |
| <Tooltip tip="Difficulty of installation and setup process.">Setup</Tooltip> | ✅ Easy | <Tooltip tip="Unifier Micro has the upper edge thanks to having less things to set up and maintain.">✅ Eas</Tooltip>**<Tooltip tip="Unifier Micro has the upper edge thanks to having less things to set up and maintain.">ier</Tooltip>** |
| <Tooltip tip="Difficulty of installation and setup process.">Setup</Tooltip> | ✅ Easy | <Tooltip tip="Unifier Micro has the upper edge thanks to having less things to set up and maintain.">✅ Easier</Tooltip> |
| <Tooltip tip="Overall memory usage, lower is better.">Memory usage</Tooltip> | Varies | <Tooltip tip="Unifier Micro does not have support for cogs and Plugins whatsoever, which helps reduce overall memory usage.">✅ Varies, but lower than Unifier</Tooltip> |
| <Tooltip tip="Target audience for the products.">Target users</Tooltip> | Communities of any size | Small communities |
| <Tooltip tip="Medium used to bridge messages to a platform.">Bridge medium</Tooltip> | <Tooltip tip="Unifier uses webhooks on platforms like Discord and Guilded to bridge messages, while it uses regular bot messages on platforms like Revolt.">Hybrid</Tooltip> | Webhooks |
4 changes: 2 additions & 2 deletions compare/platform-features.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: "Platform features"
description: "Unifier features each supported platform has."
title: "Platform Features"
description: "Unifier Components that each supported platform has."
icon: "circle-nodes"
---

Expand Down
107 changes: 0 additions & 107 deletions development.mdx

This file was deleted.

8 changes: 4 additions & 4 deletions docs.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://mintlify.com/docs.json",
"theme": "maple",
"name": "Unifier Wiki",
"name": "UnifierHQ Wiki",
"colors": {
"primary": "#ff4545",
"light": "#ff838c",
Expand All @@ -10,11 +10,11 @@
"icons": {
"library": "fontawesome"
},
"favicon": "/favicon.png",
"favicon": "/logo/favicon.png",
"navigation": {
"groups": [
{
"group": "Setting up",
"group": "Setting Up",
"icon": "rocket",
"pages": [
"setup/introduction",
Expand All @@ -29,7 +29,7 @@
]
},
{
"group": "Self-hosting",
"group": "Self Hosting",
"icon": "screwdriver-wrench",
"pages": [
"selfhost/introduction",
Expand Down
Binary file removed favicon.png
Binary file not shown.
15 changes: 8 additions & 7 deletions index.mdx
Original file line number Diff line number Diff line change
@@ -1,21 +1,22 @@
---
title: "Main page"
title: "Home"
icon: house
---

Welcome to Unifier's official wiki\!
Welcome to **UnifierHQ's Official Wiki**! Here, you can find essential guides which explains how to setup and use Unifier. These guides will also teach you everything to know your way around Unifier.

Here you can find essential guides for setting up and using Unifier, and pretty much anything you need to know to know your way around.
## Get Started

## Pages to check out
Here are a few guides to get started with Unifier! Select any of the **4 options** below to begin your journey with Unifier.

<CardGroup cols={2}>
<Card title="Setting up Unifier" icon="sparkles" href="/setup/introduction">
<Card title="Setting Up Unifier" icon="sparkles" href="/setup/introduction">
Already have a Unifier instance? Let's set it up for your community (or communities).
</Card>
<Card title="Self-hosting Unifier" icon="download" href="/selfhost/introduction">
<Card title="Self Hosting Unifier" icon="download" href="/selfhost/introduction">
Learn how to self-host your very own Unifier instance with our install guide.
</Card>
<Card title="Moderation tools" icon="shield" href="/guides/moderation/moderation-tools">
<Card title="Moderation Tools" icon="shield" href="/guides/moderation/moderation-tools">
Worried about bad actors taking advantage of the bridge? Unifier's moderation tools can help.
</Card>
<Card title="Filters" icon="flag" href="/guides/moderation/filters">
Expand Down
4 changes: 2 additions & 2 deletions legal/guidelines.mdx
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
---
title: Community guidelines
title: Community Guidelines
description: Our rules that we expect everyone to follow.
icon: book
---

<Warning>
These community guidelines only applies to **UnifierHQ-owned instances**. If your instance is not owned by UnifierHQ, refer to the instance's own guidelines.
These Community Guidelines only applies to **UnifierHQ-owned instances**. If your instance is not owned by UnifierHQ, refer to the instance's own guidelines.
</Warning>

Effective: 2025/02/17
Expand Down
Loading