Skip to content

Commit d3cd00e

Browse files
fix some legacy ARA docs
1 parent 6d06b93 commit d3cd00e

2 files changed

Lines changed: 106 additions & 78 deletions

File tree

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
// .vitepress/config.mts
2+
import { defineConfig } from "file:///E:/dev/wiki/node_modules/vitepress/dist/node/index.js";
3+
import { tabsMarkdownPlugin } from "file:///E:/dev/wiki/node_modules/vitepress-plugin-tabs/dist/index.js";
4+
import { withSidebar } from "file:///E:/dev/wiki/node_modules/vitepress-sidebar/dist/index.js";
5+
6+
// lib/components/ContentToggle.tsx
7+
import React, { useState, useEffect } from "file:///E:/dev/wiki/node_modules/react/index.js";
8+
import Cookies from "file:///E:/dev/wiki/node_modules/js-cookie/dist/js.cookie.mjs";
9+
var ToggleComponent = () => {
10+
const [isEnabled, setIsEnabled] = useState(false);
11+
useEffect(() => {
12+
const savedState = Cookies.get("toggleState");
13+
if (savedState) {
14+
setIsEnabled(savedState === "true");
15+
}
16+
}, []);
17+
const handleToggle = () => {
18+
const newState = !isEnabled;
19+
setIsEnabled(newState);
20+
Cookies.set("toggleState", newState.toString());
21+
};
22+
return /* @__PURE__ */ React.createElement("div", null, /* @__PURE__ */ React.createElement("label", null, /* @__PURE__ */ React.createElement("input", { type: "checkbox", checked: isEnabled, onChange: handleToggle }), "Toggle"), isEnabled ? /* @__PURE__ */ React.createElement("div", null, /* @__PURE__ */ React.createElement("p", null, "Second set of components")) : /* @__PURE__ */ React.createElement("div", null, /* @__PURE__ */ React.createElement("p", null, "First set of components")));
23+
};
24+
var ContentToggle_default = ToggleComponent;
25+
26+
// .vitepress/config.mts
27+
var vitePressConfigs = {
28+
title: "Aelysium Wiki",
29+
description: "The wiki for all of the Aelysium's projects, including RustyConnector",
30+
locales: {
31+
root: {
32+
label: "English",
33+
lang: "en"
34+
}
35+
},
36+
markdown: {
37+
config(md) {
38+
md.use(tabsMarkdownPlugin);
39+
},
40+
container: {
41+
tipLabel: "\u{1F4A1} TIP",
42+
warningLabel: "\u26A0\uFE0F WARNING",
43+
dangerLabel: "\u{1F525} DANGER",
44+
infoLabel: "\u{1F50E} INFO",
45+
detailsLabel: "*\uFE0F\u20E3 DETAILS"
46+
}
47+
},
48+
//ignoreDeadLinks: true,
49+
head: [["link", { rel: "icon", type: "image/png", href: "/logo.png" }]],
50+
themeConfig: {
51+
// https://vitepress.dev/reference/default-theme-config
52+
logo: "/logo.png",
53+
nav: [
54+
{ text: "RustyConnector", link: "/rusty-connector" },
55+
{ text: "Rusty for devs", link: "/rusty-dev" },
56+
{ text: "ARA", link: "/ara" },
57+
{ text: "Declarative YAML", link: "/declarative-yaml" }
58+
],
59+
footer: {
60+
message: "Released under the GPL-3.0 License.",
61+
copyright: "Copyright \xA9 2019-2025 AELYSIUM"
62+
},
63+
socialLinks: [
64+
{ icon: "github", link: "https://github.com/Aelysium-Group" },
65+
{ icon: "discord", link: "https://join.aelysium.group/" }
66+
]
67+
},
68+
sitemap: {
69+
hostname: "https://wiki.aelysium.group"
70+
},
71+
enhanceApp({ app }) {
72+
app.component("ToggleComponent", ContentToggle_default);
73+
}
74+
};
75+
var config_default = defineConfig(
76+
withSidebar(vitePressConfigs, [
77+
{
78+
documentRootPath: "/",
79+
scanStartPath: "rusty-connector",
80+
resolvePath: "/rusty-connector/",
81+
useTitleFromFrontmatter: true,
82+
useFolderTitleFromIndexFile: true,
83+
sortMenusByFrontmatterOrder: true
84+
},
85+
{
86+
documentRootPath: "/",
87+
scanStartPath: "declarative-yaml",
88+
resolvePath: "/declarative-yaml/",
89+
useTitleFromFrontmatter: true,
90+
useFolderTitleFromIndexFile: true,
91+
sortMenusByFrontmatterOrder: true
92+
},
93+
{
94+
documentRootPath: "/",
95+
scanStartPath: "rusty-dev",
96+
resolvePath: "/rusty-dev/",
97+
useTitleFromFrontmatter: true,
98+
useFolderTitleFromIndexFile: true,
99+
sortMenusByFrontmatterOrder: true
100+
}
101+
])
102+
);
103+
export {
104+
config_default as default
105+
};
106+
//# sourceMappingURL=data:application/json;base64,{
  "version": 3,
  "sources": [".vitepress/config.mts", "lib/components/ContentToggle.tsx"],
  "sourcesContent": ["const __vite_injected_original_dirname = \"E:\\\\dev\\\\wiki\\\\.vitepress\";const __vite_injected_original_filename = \"E:\\\\dev\\\\wiki\\\\.vitepress\\\\config.mts\";const __vite_injected_original_import_meta_url = \"file:///E:/dev/wiki/.vitepress/config.mts\";import { defineConfig } from 'vitepress'\r\nimport { tabsMarkdownPlugin } from 'vitepress-plugin-tabs'\r\nimport { withSidebar } from 'vitepress-sidebar';\r\nimport ContentToggle from '../lib/components/ContentToggle';\r\n\r\nconst vitePressConfigs = {\r\n  title: \"Aelysium Wiki\",\r\n  description: \"The wiki for all of the Aelysium's projects, including RustyConnector\",\r\n  locales: {\r\n    root: {\r\n      label: 'English',\r\n      lang: 'en'\r\n    },\r\n  },\r\n  markdown: {\r\n    config(md) {\r\n      md.use(tabsMarkdownPlugin)\r\n    },\r\n    container: {\r\n      tipLabel: '\uD83D\uDCA1 TIP',\r\n      warningLabel: '\u26A0\uFE0F WARNING',\r\n      dangerLabel: '\uD83D\uDD25 DANGER',\r\n      infoLabel: '\uD83D\uDD0E INFO',\r\n      detailsLabel: '*\uFE0F\u20E3 DETAILS',\r\n    }\r\n  },\r\n  //ignoreDeadLinks: true,\r\n  head: [['link', { rel: 'icon', type: 'image/png', href: '/logo.png' }]],\r\n  themeConfig: {\r\n    // https://vitepress.dev/reference/default-theme-config\r\n    logo: '/logo.png',\r\n    nav: [\r\n      { text: 'RustyConnector', link: '/rusty-connector' },\r\n      { text: 'Rusty for devs', link: '/rusty-dev' },\r\n      { text: 'ARA', link: '/ara' },\r\n      { text: 'Declarative YAML', link: '/declarative-yaml' }\r\n    ],\r\n    footer: {\r\n      message: 'Released under the GPL-3.0 License.',\r\n      copyright: 'Copyright \u00A9 2019-2025 AELYSIUM'\r\n    },\r\n    socialLinks: [\r\n      { icon: 'github', link: 'https://github.com/Aelysium-Group' },\r\n      { icon: 'discord', link: 'https://join.aelysium.group/' }\r\n    ]\r\n  },\r\n  sitemap: {\r\n    hostname: 'https://wiki.aelysium.group'\r\n  },\r\n  enhanceApp({ app }) {\r\n    app.component('ToggleComponent', ContentToggle);\r\n  }\r\n}\r\n\r\nexport default defineConfig(\r\n  withSidebar(vitePressConfigs, [\r\n    {\r\n      documentRootPath: '/',\r\n      scanStartPath: 'rusty-connector',\r\n      resolvePath: '/rusty-connector/',\r\n      useTitleFromFrontmatter: true,\r\n      useFolderTitleFromIndexFile: true,\r\n      sortMenusByFrontmatterOrder: true,\r\n    },\r\n    {\r\n      documentRootPath: '/',\r\n      scanStartPath: 'declarative-yaml',\r\n      resolvePath: '/declarative-yaml/',\r\n      useTitleFromFrontmatter: true,\r\n      useFolderTitleFromIndexFile: true,\r\n      sortMenusByFrontmatterOrder: true,\r\n    },\r\n    {\r\n      documentRootPath: '/',\r\n      scanStartPath: 'rusty-dev',\r\n      resolvePath: '/rusty-dev/',\r\n      useTitleFromFrontmatter: true,\r\n      useFolderTitleFromIndexFile: true,\r\n      sortMenusByFrontmatterOrder: true,\r\n    }\r\n  ])\r\n);", "import React, { useState, useEffect } from 'react';\r\nimport Cookies from 'js-cookie';\r\n\r\nconst ToggleComponent = () => {\r\n    const [isEnabled, setIsEnabled] = useState(false);\r\n\r\n    useEffect(() => {\r\n        const savedState = Cookies.get('toggleState');\r\n        if (savedState) {\r\n            setIsEnabled(savedState === 'true');\r\n        }\r\n    }, []);\r\n\r\n    const handleToggle = () => {\r\n        const newState = !isEnabled;\r\n        setIsEnabled(newState);\r\n        Cookies.set('toggleState', newState.toString());\r\n    };\r\n\r\n    return (\r\n        <div>\r\n            <label>\r\n                <input type=\"checkbox\" checked={isEnabled} onChange={handleToggle} />\r\n                Toggle\r\n            </label>\r\n            {isEnabled ? (\r\n                <div>\r\n                    {/* Second set of child components */}\r\n                    <p>Second set of components</p>\r\n                </div>\r\n            ) : (\r\n                <div>\r\n                    {/* First set of child components */}\r\n                    <p>First set of components</p>\r\n                </div>\r\n            )}\r\n        </div>\r\n    );\r\n};\r\n\r\nexport default ToggleComponent;"],
  "mappings": ";AAAoP,SAAS,oBAAoB;AACjR,SAAS,0BAA0B;AACnC,SAAS,mBAAmB;;;ACF5B,OAAO,SAAS,UAAU,iBAAiB;AAC3C,OAAO,aAAa;AAEpB,IAAM,kBAAkB,MAAM;AAC1B,QAAM,CAAC,WAAW,YAAY,IAAI,SAAS,KAAK;AAEhD,YAAU,MAAM;AACZ,UAAM,aAAa,QAAQ,IAAI,aAAa;AAC5C,QAAI,YAAY;AACZ,mBAAa,eAAe,MAAM;AAAA,IACtC;AAAA,EACJ,GAAG,CAAC,CAAC;AAEL,QAAM,eAAe,MAAM;AACvB,UAAM,WAAW,CAAC;AAClB,iBAAa,QAAQ;AACrB,YAAQ,IAAI,eAAe,SAAS,SAAS,CAAC;AAAA,EAClD;AAEA,SACI,oCAAC,aACG,oCAAC,eACG,oCAAC,WAAM,MAAK,YAAW,SAAS,WAAW,UAAU,cAAc,GAAE,QAEzE,GACC,YACG,oCAAC,aAEG,oCAAC,WAAE,0BAAwB,CAC/B,IAEA,oCAAC,aAEG,oCAAC,WAAE,yBAAuB,CAC9B,CAER;AAER;AAEA,IAAO,wBAAQ;;;ADnCf,IAAM,mBAAmB;AAAA,EACvB,OAAO;AAAA,EACP,aAAa;AAAA,EACb,SAAS;AAAA,IACP,MAAM;AAAA,MACJ,OAAO;AAAA,MACP,MAAM;AAAA,IACR;AAAA,EACF;AAAA,EACA,UAAU;AAAA,IACR,OAAO,IAAI;AACT,SAAG,IAAI,kBAAkB;AAAA,IAC3B;AAAA,IACA,WAAW;AAAA,MACT,UAAU;AAAA,MACV,cAAc;AAAA,MACd,aAAa;AAAA,MACb,WAAW;AAAA,MACX,cAAc;AAAA,IAChB;AAAA,EACF;AAAA;AAAA,EAEA,MAAM,CAAC,CAAC,QAAQ,EAAE,KAAK,QAAQ,MAAM,aAAa,MAAM,YAAY,CAAC,CAAC;AAAA,EACtE,aAAa;AAAA;AAAA,IAEX,MAAM;AAAA,IACN,KAAK;AAAA,MACH,EAAE,MAAM,kBAAkB,MAAM,mBAAmB;AAAA,MACnD,EAAE,MAAM,kBAAkB,MAAM,aAAa;AAAA,MAC7C,EAAE,MAAM,OAAO,MAAM,OAAO;AAAA,MAC5B,EAAE,MAAM,oBAAoB,MAAM,oBAAoB;AAAA,IACxD;AAAA,IACA,QAAQ;AAAA,MACN,SAAS;AAAA,MACT,WAAW;AAAA,IACb;AAAA,IACA,aAAa;AAAA,MACX,EAAE,MAAM,UAAU,MAAM,oCAAoC;AAAA,MAC5D,EAAE,MAAM,WAAW,MAAM,+BAA+B;AAAA,IAC1D;AAAA,EACF;AAAA,EACA,SAAS;AAAA,IACP,UAAU;AAAA,EACZ;AAAA,EACA,WAAW,EAAE,IAAI,GAAG;AAClB,QAAI,UAAU,mBAAmB,qBAAa;AAAA,EAChD;AACF;AAEA,IAAO,iBAAQ;AAAA,EACb,YAAY,kBAAkB;AAAA,IAC5B;AAAA,MACE,kBAAkB;AAAA,MAClB,eAAe;AAAA,MACf,aAAa;AAAA,MACb,yBAAyB;AAAA,MACzB,6BAA6B;AAAA,MAC7B,6BAA6B;AAAA,IAC/B;AAAA,IACA;AAAA,MACE,kBAAkB;AAAA,MAClB,eAAe;AAAA,MACf,aAAa;AAAA,MACb,yBAAyB;AAAA,MACzB,6BAA6B;AAAA,MAC7B,6BAA6B;AAAA,IAC/B;AAAA,IACA;AAAA,MACE,kBAAkB;AAAA,MAClB,eAAe;AAAA,MACf,aAAa;AAAA,MACb,yBAAyB;AAAA,MACzB,6BAA6B;AAAA,MAC7B,6BAA6B;AAAA,IAC/B;AAAA,EACF,CAAC;AACH;",
  "names": []
}


rusty-dev/documentation/ara-simple.md

Lines changed: 0 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -159,17 +159,6 @@ Generally speaking you're allowed to put boot logic for the Particle in either t
159159
In practice, however, we like having the separation where the ignite method is exclusively for configuring and instantiating,
160160
and the constructor is for that boot logic.
161161

162-
::: info What is ModuleTinder?
163-
Inside RustyConnector, we use ModuleTinder instead of the ARA native Tinder.
164-
A main details as to why is because ModuleTinder accepts metadata about the specific module.
165-
166-
Any time you are wanting to create a new module/particle, you want to make sure your Tinder extends that ModuleTinder class.
167-
Here's a description of each option in the ModuleTinder constructor and what they do:
168-
1. **Name** | The unique name of the module. (ex. LangLibrary, FamilyRegistry, etc.)
169-
2. **Description** | Describes the general purpose and use of the module.
170-
3. **Details** | The name of the Lang entry that displays more details about this specific module.
171-
:::
172-
173162
## Particle/Module Collections
174163
There are two classes that represent collections of modules in RustyConnector.
175164

@@ -183,70 +172,3 @@ wrappers know that a module contains children.
183172
### `ModuleCollection`
184173
Implementing the `ModuleHolder` interface, the `ModuleCollection` class provides complete module management.
185174
It's the class that the RustyConnector kernel uses to handle its own modules.
186-
187-
## Tinder Injection
188-
189-
The Tinder system give module developers the ability to directly alter code being executed even by the kernel itself.
190-
Let's look at MagicLink as an example.
191-
By default, MagicLink operates via WebSocket.
192-
However, if a module developer wanted to implement Redis instead of WebSocket, they could do so with relative ease.
193-
```java
194-
public class RedisMagicLink extends MagicLinkCore.Proxy {
195-
protected RedisMagicLink(
196-
@NotNull Packet.SourceIdentifier self,
197-
@NotNull AES cryptor,
198-
@NotNull PacketCache cache,
199-
@Nullable IPV6Broadcaster broadcaster
200-
) {
201-
super(self, cryptor, cache, broadcaster);
202-
// Redis Initializer logic
203-
}
204-
205-
@Override
206-
public void publish(Packet.Local packet) throws IllegalStateException {
207-
// Publish using Redis
208-
}
209-
210-
public static class Tinder extends MagicLinkCore.Tinder<RedisMagicLink> {
211-
private final Packet.SourceIdentifier self;
212-
private final AES cryptor;
213-
private final PacketCache cache;
214-
private final IPV6Broadcaster broadcaster;
215-
public Tinder(
216-
@NotNull URL httpAddress,
217-
@NotNull Packet.SourceIdentifier self,
218-
@NotNull AES cryptor,
219-
@NotNull PacketCache cache,
220-
@Nullable IPV6Broadcaster broadcaster
221-
) {
222-
super();
223-
this.cryptor = cryptor;
224-
this.self = self;
225-
this.cache = cache;
226-
this.broadcaster = broadcaster;
227-
}
228-
229-
@Override
230-
public @NotNull RedisMagicLink ignite() throws Exception {
231-
return new RedisMagicLink(
232-
this.self,
233-
this.cryptor,
234-
this.cache,
235-
this.broadcaster
236-
);
237-
}
238-
}
239-
}
240-
```
241-
Naturally a module developer would also need to add parameters for Redis login details as well, that's besides the point tho.
242-
Remember how a Tinder is basically just a configuration class? This is where that fact truly shines.
243-
244-
In order to inject this new Tinder so that the RustyConnector kernel uses it instead of the default WebSocket Tinder,
245-
you first need to acquire the current MagicLink Flux, then reload the Flux using the new Tinder.
246-
```java
247-
RC.Kernel().fetchModule("MagicLink").reignite(new RedisMagicLink.Tinder(/* params */));
248-
```
249-
250-
From this point forward, any time the MagicLink Flux is stopped, started, or reloaded, the new Tinder will be used.
251-
The caller also has an optional `rollback` flag they can pass which, if there's an exception during the boot process of a Particle,
252-
will automatically discard the newly passed Tinder and revert to the previous one.

0 commit comments

Comments
 (0)