Skip to content

Commit 3a300f3

Browse files
Update docs to: Add Marketplace browsing and installation feature (#106)
1 parent 66dfa32 commit 3a300f3

2 files changed

Lines changed: 59 additions & 17 deletions

File tree

docs/modes.md

Lines changed: 50 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -90,13 +90,56 @@ In programming word, there is a lot of types of programmers, for example you can
9090
need to work with some files as your basic workflow, such as `.html`, `.css`, and `.js`. So we provide mode kits, a
9191
mode kit is a collection from related modes create for a special type of users.
9292

93-
## Installing Modes & Mode Kits
93+
## Installing
9494

95-
You can find modes and mode kits in official library or community created collections, there is some useful link about modes:
95+
You can install modes in different ways. In this section, we will explain standard ways.
9696

97-
- [Currently Available Modes List](https://github.com/text-forge/mode-library#mode-support-status)
98-
- [Official Mode Library](https://github.com/text-forge/mode-library)
97+
### From Marketplace
9998

100-
A mode or mode kit is a `.zip` or `.tfmode` file, use **Mode Manager** (`Settings > Mode Manager` in menus) and select
101-
this file with `Import Mode / Mode Kit`. After loading, you will receive an **info** notification that says
102-
`"Load mode / mode kit completed"` and you can use your new modes now without restart editor.
99+
Marketplace is useful feature to install modes is simplest way. This way also protect you from incompatible modes and
100+
limits them.
101+
102+
To install a mode / mode kit from marketplace, go to **Settings > Marketplace** and select **Modes** category, then
103+
click on a mode to see its details. You can use **Install** button to download and install mode. If this button is
104+
disabled your editor isn't compatible with this mode, you can find another mode or try other ways.
105+
106+
After clicking on Install button, you should wait until see **Package Installed!** notification, then you can use your
107+
new mode without restarting the editor.
108+
109+
!!! Note
110+
111+
You can install these modes in this way:
112+
- Modes in [Marketplace](https://github.com/text-forge/marketplace)
113+
114+
### From Mode Manager
115+
116+
You can download mode installation files, this file is a `.zip` or `.tfmode` file that you can download it from mode
117+
providers, use **Mode Manager** (`Settings > Mode Manager` in menus) and select this file with `Import Mode / Mode Kit`.
118+
After loading, you will receive an **info** notification that says `"Load mode / mode kit completed"` and you can use
119+
your new modes now without restarting the editor.
120+
121+
!!! Caution
122+
123+
This installation doesn't check for mode compability!
124+
125+
!!! Note
126+
127+
You can install these modes in this way:
128+
- Modes in [Mode Library](https://github.com/text-forge/mode-library)
129+
- Modes in [GitHub's `text-forge` topic](https://github.com/topics/text-forge)
130+
- Any mode that provides `.zip` or `.tfmode` as installation file.
131+
132+
### From Mode Source
133+
134+
Modes works in isolated eviroment, so you can transfer their files to another editor data folder and use them there.
135+
For this installation way you should have a mode source that you can get it from GitHub or somewhere else. To install
136+
one or more mode from source use **Settings > Open Data Folder** and paste mode folder in `modes/` directory. When you
137+
restart your editor you can use new mode.
138+
139+
!!! Note
140+
141+
You can install these modes in this way:
142+
- Modes in [Mode Library](https://github.com/text-forge/mode-library)
143+
- Modes in [GitHub's `text-forge` topic](https://github.com/topics/text-forge)
144+
- Modes installed in another device or user data.
145+
- Any mode that provides source code.

docs/setup.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,28 @@
11
# Setup
22

3-
Text Forge currently supports Linux and Windows (You can use it on other platforms with build it from source), Just download [latest](https://github.com/text-forge/text-forge/releases/latest) and install it! (or download portable version and extract it anywhere you want)
3+
Text Forge currently supports Linux and Windows (You can use it on other platforms with build it from source), Just download [latest](https://github.com/text-forge/text-forge/releases/latest) and extract it where your want!
44

55
!!! Note
66

77
You can see build guide here: [Open Text Forge source in Godot](build.md)
88

9-
Now you can run Text Forge:
9+
Now you can run Text Forge with `Text Forge` runnable file:
1010

1111
![image.png](https://text-forge.github.io/docs/img/setup_screenshot.png)
1212

1313
## Install Modes
1414

1515
Now, you have a very lightweight editor, it's more like a core. There is a lot of plugged modules like action scripts,
16-
panel, etc. but you need another type of module too for work with you editor. This type is **Mode**, you can find more
17-
about modes [here](modes.md), but for now let's get your modes from official mode library!
16+
panels, etc. but you need another type of module too for work with you editor. This type is **Mode**, you can find more
17+
about modes [here](modes.md), but for now let's get your modes from Text Forge Marketplace!
1818

19-
### Download Modes or Mode Kits
19+
You can use **Settings > Marketplace** to find themes, extensions, and modes and install them in one click. For modes, use filter
20+
option in top-right corner of marketplace window and set it from *All* to *Modes*. Now you can see available modes, click on a mode
21+
to see it's details, if it's what you want click on **Install** button and wait until **Package Installed!** notification.
2022

21-
You can go [here](https://github.com/text-forge/mode-library) to find and download modes you want. Just click on name of
22-
mode you want and read setup guide in mode repository.
23+
!!! Tip
2324

24-
Then, you have one (or more) `.zip` or `.tfmode` file, you can import them with `Settings > Mode Manager > Import Mode / Mode Kit`,
25-
If everything done well, you will receive an **info** notification that says `"Load mode / mode kit completed"` and you
26-
can use your new modes now without restart editor.
25+
You can find about mode installation [here](modes.md#installing).
2726

2827
## Open A File
2928

0 commit comments

Comments
 (0)