Skip to content

Commit

Permalink
remove remaining mentions of plugins following #50
Browse files Browse the repository at this point in the history
  • Loading branch information
TicClick committed Jan 12, 2024
1 parent 6c2222a commit 1329add
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 33 deletions.
10 changes: 1 addition & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@
- favourite channel list
- a Google Translate shortcut on chat messages
- a slightly customizable UI palette
- rudimentary plugin system (shit may break, but plugin-breaking changes will be indicated)

## where?

Expand All @@ -34,14 +33,7 @@ right now, it's the [IRC](https://osu.ppy.sh/wiki/IRC) gateway, but hopefully th

### will you know my password?

no: it's stored locally, and only sent to the chat server -- see the source code, or listen to the app's network activity. two things to make a note of, though:
no: it's stored locally, and only sent to the chat server -- see the source code, or listen to the app's network activity. one to make a note of, though:

- it may be not safe from the plugins -- "install" them only if you trust their developers.
- since the IRC server doesn't support SSL, the password is sent in CLEAR TEXT -- if someone is spying on the network, they will be able to eavesdrop and take it.
- on the other hand, if someone is spying on you, an exposed osu! **chat** password is one of the least concerns..

### plugins?

yeah, the app is to a certain degree extensible -- it's possible to make a Rust dynamic library using the interface from [`steel_plugin`](https://github.com/TicClick/steel/tree/master/crates/steel_plugin). please note that the dependencies are non-ABI safe -- as mentioned before, shit may break (either by itself, or by not yours truly).

still, something can definitely be hacked together!
7 changes: 0 additions & 7 deletions crates/steel_core/src/settings/application.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,17 +2,10 @@ use serde::{Deserialize, Serialize};

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct Application {
#[serde(default)]
pub plugins: Plugins,
#[serde(default)]
pub autoupdate: AutoUpdate,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct Plugins {
pub enabled: bool,
}

#[derive(Clone, Debug, Default, Serialize, Deserialize)]
pub struct AutoUpdate {
pub enabled: bool,
Expand Down
20 changes: 3 additions & 17 deletions src/gui/settings/application.rs
Original file line number Diff line number Diff line change
Expand Up @@ -18,25 +18,11 @@ impl SettingsWindow {
"checked every {} minutes. to apply an update, restart the application",
crate::core::updater::AUTOUPDATE_INTERVAL_MINUTES
);
ui.checkbox(&mut state.settings.application.autoupdate.enabled, "enable automatic updates")
.on_hover_text_at_pointer(hint);

ui.heading("plugins");
if !state.settings.application.plugins.enabled {
ui.label(
"plugins are third-party modules (.dll, .so) which add extra functions. \
to activate a plugin, place its file into the application's folder and restart it.\n\
\n\
beware that plugins can THEORETICALLY do anything in the application, or on your PC, that you can, so \
only add them if you know and trust their authors.",
);
}

ui.checkbox(
&mut state.settings.application.plugins.enabled,
"enable plugins",
&mut state.settings.application.autoupdate.enabled,
"enable automatic updates",
)
.on_hover_text_at_pointer("requires application restart");
.on_hover_text_at_pointer(hint);
});

if autoupdate != state.settings.application.autoupdate.enabled {
Expand Down

0 comments on commit 1329add

Please sign in to comment.