Skip to content

Commit a8abc7d

Browse files
committed
cli: scli config
1 parent 8a42889 commit a8abc7d

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

docs/CLI/scli_config.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# SCLI_CONFIG
2+
3+
Scli config is a means of saving extra information for the scratchattach CLI for a user.
4+
It is stored in a shared project on that user's profile.
5+
6+
The project ID for scli config is stored using base128 or something using ASCII chars and some emojis to use as few chars as possible.
7+
It will be separated from everything else by a space or newline.
8+
9+
Example of a SCLI-Config compliant `About me` for [faretek1](https://scratch.mit.edu/users/faretek1/)
10+
```html
11+
That the true meaning of life is to expend every resource, every second, and every thought, so as to spend as much time on thy computer as possible.
12+
13+
1216591875 <!-- TODO: change this to the special encoded text --> <!-- The associated project: https://scratch.mit.edu/projects/1216591875/ -->
14+
```
15+
16+
The actual scli config data will be stored in a comment inside the project.
17+
18+
the project must be named `_SCLI_CONFIG_` without no sprites - only the stage - with only 1 comment,
19+
which would be the scli config data, which must end in `_SCLI_CONFIG_`
20+
21+
The project must be owned by the associated user or be in the saved sessions list (can be outside the group).

0 commit comments

Comments
 (0)