You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It will convert all shimejis from img/ directory of the Shimeji-ee instance to the wl_shimeji format and save them to .local/share/wl_shimeji/shimejis/ directory.
55
+
It will try to read the zip archive and will ask you to select which mascots you want to convert:
56
+
```bash
57
+
$ shimejictl convert "The Neuroling Collection v0.7.zip" -O output/
58
+
Prototypes available for conversion:
59
+
1. Weuron
60
+
2. Vedaling
61
+
3. Tuteling Cursor
62
+
4. Tuteling
63
+
5. Neuron
64
+
6. Neuroling
65
+
7. Eviling
66
+
8. Evil Neuroling
67
+
9. Broken Neuron
68
+
69
+
Enter prototypes index or name to convert (can be comma-separated or A to convert all)
70
+
>
71
+
```
52
72
53
-
## Summoning mascots
54
-
After you converted your mascots, you can summon them to the screen, but first you need to know the name of the mascot you want to summon.
73
+
When you selected mascot types that you need, shimejictl will convert them to the wl_shimeji format and will save them to the output directory with names like
74
+
`Shimeji.{mascot_name}.wlshm`
55
75
56
-
```sh
57
-
shimejictl list
58
-
```
59
-
It will print the list of all available mascots.
76
+
# Importing .wlshm prototypes
60
77
61
-
Then you can summon mascots by three ways:
62
-
1. By name, on random screen:
78
+
After you successfully converted your mascots, you can import them to the wl_shimeji format using the following command:
If prototype already exists, shimejictl will skip it unless -f is used.
84
+
85
+
# Listing available prototypes
86
+
87
+
You can list all available mascot prototypes using the following command:
67
88
```sh
68
-
shimejictl summon mascot_name --select
89
+
shimejictl prototypes list
69
90
```
70
-
3. You can summon all known mascots at once (Note: it will only work if overlay is not running):
91
+
92
+
# Summoning mascots
93
+
94
+
To summon mascot, you need to know mascot's name, which you can get by using `shimejictl prototypes list` command. When you found mascot of your choice, you can summon using `shimejictl mascot summon {name}` command, where `{name}` is the name of the mascot you want to summon.
95
+
96
+
For example, if you want to summon a mascot named Neuron, you can use the following command:
71
97
```sh
72
-
shimejictl summon all
98
+
shimejictl mascot summon Neuron
73
99
```
74
100
75
-
All summon commands will start the overlay if it's not running.
101
+
If you want to summon mascot at specific location, you can use --select flag or pass your coordinates as -x -y or -position x,y
76
102
77
103
## Dismissing mascots
78
-
You can dismiss mascots by using `shimejictl dismiss` command.
79
104
80
-
```sh
81
-
shimejictl dismiss
82
-
```
83
-
It will ask you to select the mascot you want to dismiss.
84
-
Command also takes three flags:
85
-
-`--all` - dismiss all mascots at once (mutually exclusive with `--all-other`)
86
-
-`--all-other` - dismiss all mascots except the selected one (mutually exclusive with `--all`)
87
-
-`--same` - tells overlay to target mascots of the same type as the selected one
105
+
To dismiss mascot, you can use `shimejictl mascot dismiss` command.
106
+
shimejictl will ask you to click on target mascot.
107
+
Also we have flags that can be used to dismiss multiple mascots at once.
108
+
Use shimejictl mascot dismiss --help to see all available flags.
88
109
89
-
So for example following command will dismiss all mascots:
90
-
```sh
91
-
shimejictl dismiss --all
92
-
```
110
+
## Setting mascots behaviors
111
+
112
+
You can replace mascot's behavior by using `shimejictl mascot set-behavior {behavior}` command, where `{behavior}` is the name of the behavior you want to set. shimejictl will ask you to click on target mascot.
113
+
114
+
You can get all available behaviors by using `shimejictl prototypes info {prototype_name}` command, where `{prototype_name}` is the name of the mascot prototype you want to get information about.
115
+
116
+
# Exporting prototypes
117
+
118
+
You can export mascot prototype by using `shimejictl prototypes export` command. It will produce .wlshm file that you can then share with others.
93
119
94
-
And this command will dismiss all mascots of the same type as the selected one:
@@ -115,61 +140,47 @@ Or values of all options by using `list` action:
115
140
shimejictl config list
116
141
```
117
142
118
-
Config file is usually located at .config/wl_shimeji/shimeji.conf
143
+
Config file is usually located at .config/wl_shimeji/shimeji-overlayd.conf
119
144
120
145
# Advanced usage
121
146
122
-
## Using custom config path
123
-
`shimejictl` takes `--config-path` argument to specify custom path to the configuration directory.
147
+
## Multihead usage
124
148
125
-
## Converting mascots on individual basis
126
-
You can convert mascots to the wl_shimeji format on individual basis by using `shimejictl convert` command.
149
+
wl_shimeji supports multiple screens. However, some features may be disabled by default. Config provides following options:
150
+
- ALLOW_THROWING_MULTIHEAD: Allows throwing mascot between screens
151
+
- ALLOW_DRAGGING_MULTIHEAD: Allows dragging mascot between screens
152
+
- UNIFIED_OUTPUTS: Treats all outputs as one entity
127
153
128
-
```sh
129
-
shimejictl convert .../Shimeji-EE/img/mascot_name
130
-
```
131
-
Following command will convert mascot with the name `mascot_name` from the Shimeji-ee instance to the wl_shimeji format and save it to .local/share/wl_shimeji/shimejis/ directory.
132
-
IMPORTANT: `convert` command doesn't have full instance context, so conf/ subdirectory with actions.xml and behaviors.xml inside the mascot directory *IS REQUIRED*.
154
+
You may want block one of displays from being used by wl_shimeji in runtime, so we have `shimejictl environment close` to disable one of outputs. shimejictl will ask you to select one of outputs by clicking on it. After this operation, you can't restore display unless you restart wl_shimeji or reconnect display to the system.
133
155
134
-
## Getting mascot information
135
-
Useful for debugging, `shimejictl info` command prints information about the selected mascot.
156
+
## Interpolation
136
157
137
-
```sh
138
-
shimejictl info
139
-
```
158
+
wl_shimeji supports movement interpolation of mascots. You can enable it by setting INTERPOLATION_FRAMERATE to value that is not equal to 0. Values > 0 used as interpolation frame rate. -1 Picks output's refresh rate as interpolation frame rate. Values under -1 are not allowed.
140
159
141
-
## Launching overlay in the foreground
142
-
`shimejictl foreground` command launches overlay in the foreground.
160
+
## Tablets
143
161
144
-
```sh
145
-
shimejictl foreground
146
-
```
162
+
wl_shimeji recognized pentablets as input method, so you can use it as input device. However, currently subsurfaces bugged under KDE when using them with wp-tablet-v2, so you may want to disable that feature by setting TABLETS_ENABLED to false.
147
163
148
-
## Exporting configurations
149
-
To export already converted mascots to a configuration pack, use the export subcommand. This will create a zip archive containing all mascots and their configurations, named export.wlshm in the current directory.
164
+
## Mapping mouse buttons
150
165
151
-
```sh
152
-
shimejictl export
153
-
```
166
+
You can map mouse button and tablet events (stylus down, stylus up) to different actions. For example you can remap right button to 0x01, so it will act as left button and etc.
154
167
155
-
You can also specify a custom output path by passing it as an argument:
156
-
157
-
```sh
158
-
shimejictl export /path/to/output/file.wlshm
159
-
```
168
+
## Using systemd socket
160
169
161
-
You can import this configuration pack later by using `import` subcommand.
170
+
wl_shimeji can be activated on-demand through systemd socket. To enable it, use 'systemctl --use enable wl_shimeji.socket'.
162
171
163
172
## Running overlay manually
164
173
You can start overlay manually by running `shimeji-overlayd`. It's not recommended and *useless* in case you don't pass -se flag to it or
165
174
if you don't pass unix fd using -cfd flag, unless you implementing another frontend for the overlay. If -se or -cfd not specified
166
175
overlay will close immediately after start.
167
176
168
177
Arguments:
169
-
-`-s` - path to the overlay socket file.
170
-
-`-c`- path to the configuration directory.
178
+
-`-s`, `--socket-path` - path to the overlay socket file.
179
+
-`-cd`, `--configuration-root`- path to the configuration root of the wl_shimeji (/home/kotb/.local/share/wl_shimeji by default)
171
180
-`-cfd`, `--caller-fd` - paired unix socket fd used for communication. If closed and no other clients connected nor no mascots exists, overlay will close.
172
-
-`-p` - path to the plugins directory.
181
+
-`-c` - config file path.
182
+
-`-pl` - path to the plugins directory.
183
+
-`-pr` - path to the prototypes directory.
173
184
-`-se` - summon everyone. If specified, overlay will summon all known mascots upon start.
174
185
-`-v`, `--version` - version of the overlay.
175
186
-`--no-tablets` - disable wp_tablet_v2 wayland protocol support. (broken on kwin right now anyway)
0 commit comments