Skip to content

Commit 1aed890

Browse files
authored
More wiki cleanup (Card-Forge#9232)
1 parent df86f60 commit 1aed890

File tree

27 files changed

+117
-199
lines changed

27 files changed

+117
-199
lines changed

docs/AI.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# About Forge's Artificial Intelligence
2-
32
The AI is *not* "trained". It uses basic rules and can be easy to overcome knowing its weaknesses.
43

54
The AI is:
@@ -13,13 +12,11 @@ Defining general concepts of smart play can help improve the win rate much easie
1312
If you want to train a model for the AI, please do. We would love to see something like that implemented in Forge.
1413

1514
# AI Matches from Command Line
16-
1715
The AI can battle itself in the command line, allowing the tests to be performed on headless servers or on computers that have poor graphic performance, and when you just don't need to see the match. This can be useful if you want to script testing of decks, test a large tournament, or just bash 100's of games out to see how well a deck performs.
1816

1917
Please understand, the AI is still the AI, and it's limitations exist even against itself. Games can lag and become almost unbearably long when the AI has a lot to think about, and you can't see what's on the table for it to play against. It's best if you set up the tournament and walk away, you can analyze logs later, results are printed at the end.
2018

21-
## Syntax
22-
19+
## Syntax
2320
`sim -d <deck1[.dck]> ... <deckX[.dck]> -D [path] -n [N] -f [F] -t [T] -p [P] -q`
2421

2522
In linux and mac, command line arguments are not currently passed through the sh script, please call `java -jar` manually, instead of the exe.

docs/Advanced-Search.md

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# Advanced Search
2-
32
Forge implements many ways to help you find the cards you want in your ever growing collection.
43

54
Pressing Ctrl+Enter in current search adds another editable search bar.
@@ -11,7 +10,6 @@ Click the "X" in the upper right corner of each search widget to remove that fil
1110
Find-as-you-type is implemented for Deck Editor tables. Just start typing while the table has focus and the next card with a matching string in its name will be highlighted. If more than one card matches, hit Enter to select the next matching card. A popup panel will appear with the search string so you know what you are searching for. If no cards match the string, the string will be highlighted in red. Find-as-you-type mode is automatically exited after 5 seconds of inactivity, or hit Escape to exit find-as-you-type mode immediately.
1211

1312
## Additional information
14-
1513
Another way to filter is using [Scryfall-like syntax](https://scryfall.com/docs/syntax) in the collection search bar.
1614

1715
If no operators are passed between tokens, Forge will assume it is joined by `and`. For example, `t:cat t:warrior t:creature` will search for "creatures that are a cat **and** a warrior". Make sure to use `|` or `or` for your queries, as well as parentheses `( )` when needed.
@@ -25,7 +23,6 @@ If no keywords are used, Forge will search in their name, type and oracle text f
2523
### Colors
2624

2725
#### Keyword(s): `color`, `c`
28-
2926
You can find cards that are a certain color using the `c:` or `color:` keyword. Both keywords accepts full color names like blue or the abbreviated color letters `w`, `u`, `r`, `b` and `g`.
3027

3128
You can use many nicknames for color sets: all guild names (e.g. `azorius`), all shard names (e.g. `bant`), all college names (e.g., `quandrix`), all wedge names (e.g. `abzan`), and the four-color nicknames `chaos`, `aggression`, `altruism`, `growth`, `artifice` are supported.
@@ -42,7 +39,6 @@ You can use comparison expressions (`>`, `<`, `>=`, `<=`, and `!=`) to check aga
4239
### Card Types
4340

4441
#### Keyword(s): `type:`, `t:`
45-
4642
Find cards of a certain card type with the `t:` or `type:` keywords. You can search for any supertype, card type, or subtype.
4743

4844
Using only partial words is allowed.
@@ -54,7 +50,6 @@ Using only partial words is allowed.
5450
### Card Text
5551

5652
#### Keyword(s): `oracle:`, `o:`
57-
5853
Use the `o:` or `oracle:` keywords to find cards that have specific phrases in their text box.
5954

6055
You must put quotes `" "` around text with punctuation or spaces.
@@ -63,7 +58,6 @@ You must put quotes `" "` around text with punctuation or spaces.
6358
`o:"enters tapped"` - Cards that enter the battlefield tapped
6459

6560
#### Keyword(s): `keyword:`, `kw:`
66-
6761
You can use `keyword:` or `kw:` to search for cards with a specific keyword ability.
6862

6963
> Note: Known to be buggy. You can search by oracle text instead.
@@ -72,7 +66,6 @@ You can use `keyword:` or `kw:` to search for cards with a specific keyword abil
7266
`kw:flying -t:creature` - Noncreatures that have the flying keyword
7367

7468
#### Keyword(s): `name:`
75-
7669
You can find cards with certain words in their name using `name`.
7770

7871
Supports `!` (exact search), `!=` (doesn't contain), and `:` or `=` (contains).
@@ -82,13 +75,11 @@ Supports `!` (exact search), `!=` (doesn't contain), and `:` or `=` (contains).
8275
`name:Phyrexian`- Cards that contain Phyrexian in their name
8376

8477
#### Keyword(s): `is:vanilla`
85-
8678
Find vanilla cratures (Creatures with no abilities).
8779

8880
### Mana Costs
8981

9082
#### Keyword(s): `manavalue`, `mv`, `cmc`
91-
9283
You can find cards of a specific mana value with `manavalue`, `mv`, or `cmc`, comparing with a numeric expression (>, <, =, >=, <=, and !=).
9384

9485
*Exemples:*
@@ -97,22 +88,19 @@ You can find cards of a specific mana value with `manavalue`, `mv`, or `cmc`, co
9788
### Power, Toughness, and Loyalty
9889

9990
#### Keyword(s): `power`, `pow`
100-
10191
You can use numeric expressions (>, <, =, >=, <=, and !=) to find cards with certain power using `power` or `pow`.
10292

10393
*Exemples:*
10494
`pow>=8` - Cards with 8 or more power
10595
`pow>tou c:w t:creature` - White creatures that are top-heavy
10696

10797
#### Keyword(s): `toughness`, `tou`
108-
10998
You can use numeric expressions (>, <, =, >=, <=, and !=) to find cards with certain toughness using `toughness` or `tou`.
11099

111100
*Exemples:*
112101
`tou<=4` - Cards with 4 or less thoughness
113102

114103
#### Keyword(s): `loyalty`, `loy`
115-
116104
You can use numeric expressions (`>`, `<`, `=`, `>=`, `<=`, and `!=`) to find cards with certain starting loyalty using `loyalty` or `loy`.
117105

118106
*Exemples:*
@@ -121,14 +109,12 @@ You can use numeric expressions (`>`, `<`, `=`, `>=`, `<=`, and `!=`) to find ca
121109
### Sets (Editions)
122110

123111
#### Keyword(s): `set:`, `s:`, `edition:`, `e`
124-
125112
Use `s:`, `e:`, `set:`, or `edition:` to find cards using their Magic set code.
126113

127114
Examples:
128115
`e:war` - Cards from War of the Spark
129116

130117
#### Keyword(s): `in:` (set)
131-
132118
The `in:` keyword finds cards that appeared in given set code.
133119

134120
Examples:
@@ -137,15 +123,13 @@ Examples:
137123
### Rarity
138124

139125
#### Keyword(s): `rarity:`, `r:`
140-
141126
Use `r:` or `rarity:` to find cards by their print rarity. You can search for `land` (`l`) (usually only basic lands), `common` (`c`), `uncommon` (`u`), `rare` (`r`), `mythic` (`m`), and `special` (`s`). You can also use comparison operators like `<` and `>=.`
142127

143128
Examples:
144129
`r:common t:artifact` - Common artifacts
145130
`r>=r`- Cards at rare rarity or above (rares and mythics)
146131

147132
#### Keyword(s): `in:` (rarity)
148-
149133
You can find cards that have been printed in a given rarity using `in:`
150134

151135
Examples:
@@ -154,39 +138,30 @@ Examples:
154138
### Multi-faced cards
155139

156140
#### Keyword(s): `is:split`
157-
158141
Find split-faced cards.
159142

160143
#### Keyword(s): `is:flip`
161-
162144
Find flip cards.
163145

164146
#### Keyword(s): `is:transform`
165-
166147
Find cards that transform.
167148

168149
#### Keyword(s): `is:meld`
169-
170150
Find cards that meld.
171151

172152
#### Keyword(s) `is:leveler`
173-
174153
Find cards with Level Up.
175154

176155
### Others
177156

178157
#### Keyword(s): `is:modal`
179-
180158
Find modal cards.
181159

182160
#### Keyword(s): `is:custom`
183-
184161
Find cards from custom sets.
185162

186163
#### Keyword(s) `is:foil`
187-
188164
Find foil cards.
189165

190166
#### Keyword(s) `is:nonfoil`
191-
192167
Find nonfoil cards.

docs/Adventure/Adventure-Mode.md

Lines changed: 0 additions & 12 deletions
This file was deleted.

docs/Adventure/Gameplay-Guide.md

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,11 @@
11
# Getting started
22

3-
43
## Difficulty
5-
64
The difficulty you choose will alter your starting health (15 for easy to 7 for extreme), and the amount of cards you start with when you choose the "pile" mode. Also, cards will sell for less in shops and enemies will have more health.
75

86
Another difference is that on hard/extreme difficulty, enemies that use computer-generated decks (using .json files) will instead use completely random decks that will have nothing to do with their original deck theme.
97

108
## Starting cards
11-
129
You will have multiple options as to how your starting pool of cards will look
1310

1411
1. __Pile__. This will give you a random pile of cards based on the color you choose. The harder the difficulty you choose, the fewer cards you will get.
@@ -21,15 +18,13 @@ When you use this option, it is recommended that you create a 40-card deck (mini
2118

2219
4. __Constructed__. With this setting, you start with a custom preconstructed deck based on a popular theme that's easy to expand during your run. (**Recommended for new players**). Your starting color will determine which starter deck you will get
2320

24-
## General hints and tips
25-
21+
## General hints and tips
2622
1. Don't immediately sell cards that are not useful in your current deck. Some cards can be very useful in certain boss fights, for instance, cards with " protection from red" are very strong against most red bosses.
2723
2. Make sure to travel to the biome capitals early in your run. Every capital contains a shop that sells 1 life and an item that allows you to teleport back to that capital. Also, they sell items that can't be found elsewhere.
2824
3. Every boss gives you +1 starting life. So if you're having trouble with a certain boss, it might be better to try your hand with other bosses.
2925
4. Arena challenges in the capitals can be a good source of money, items, and cards. Though you need a rather strong deck to consistently win there.
3026

3127
### Insane Guide
32-
3328
If you are playing on Insane and need some pointers, user KingNishi has written up a nice doc about it
3429

3530
https://docs.google.com/document/d/1RgO20QpdVOpU-g_E1RL8q1r0C5GUy6y-nnxgXNbi9Wg/pub
Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,20 @@
11
# The Different Planes of Adventure Mode
2-
32
In Adventure Mode, you can select different planes (AKA worlds) to experience. The default experience is the Shandalar plane, and is the basis of gameplay found in all the others. The other planes are community projects, and are in various states of completion. Below there is a list of each plane in the game (as of this writing), and it's status.
43

54
To change planes, open up Adventure Mode. On the main screen where you can either load a game or start a new one. Go to the Settings menu, and you will find a drop down on the top right with a list of the planes currently available. When changing planes, you will need to restart Forge to apply the change. Save files are unique to each plane, and will load back in when you change to the appropriate plane.
65

76
## Amonkhet
8-
97
A plane set in the world of Amonkhet, and is intended to have new quests, story, enemies, etc. based on that Magic The Gathering plane.
108

119
**STATUS:** Very broken. Not recommended for play, unless you want to dip your head in and see a very different overworld map. Pretty much nothing else works properly. _You have been warned._
1210

13-
1411
## Crystal Kingdoms
1512

1613
A plane with a focus on the Final Fantasy cards. Intended to have a unique story, quests, enemies, etc. based on the Final Fantasy games.
1714

1815
**STATUS:** Very pre-alpha. The plane 'works' but is almost identical to the default Shandalar plane. The big differences is new starting decks, and the card rewards in shops and from enemies, have a stronger Final Fantasy bent than usual.
1916

2017
## Innistrad
21-
2218
A plane set in the lore and world of Magic the Gathering's Innistrad plane. The card pool and enemies are limited to Innistrad, with some minor exceptions. There is also a distinctly different overworld, story, enemies, etc. Every map is new and unique compared to Shandalar.
2319

2420
**STATUS:** Technically alpha. Everything is 'functional' in that it is all closed off and separate from the Shandalar plane. The enemies are new, the quests include some base and some new (though the tutorial has some strong similarities). The shops are new-ish (they currently use the base shops, but with a limited card pool to just the plane. This is actively being changed to entirely new shops however, and should become notable in the next few updates.) Every town, dungeon, and cave is unique to Innistrad and been custom built for the plane. Every enemy is also new to Innistrad.
@@ -28,13 +24,11 @@ _HOWEVER_: Everything is still very early in design. Most of the biomes are empt
2824
In it's current state, expect to find bugs. if you do, please report them to Shenshinoman in the Forge Discord.
2925

3026
## Shandalar
31-
3227
The base plane, where all the magic happens, and where the dev team members working on Adventure generally focus their efforts. The story is mostly complete, but there _is_ further work planned. Everything works, and you can easily spend dozens of hours, or more, in this plane.
3328

3429
**STATUS:** Fully functional and live. Enjoy!
3530

3631
## Shandalar Old Border
37-
3832
So, you like the Shandalar plane, but miss "ye good olde days" of yore? Then Shandalar Old Border is for you. This is the Shandalar base plane, but with modifications so that everything is from the Scourge set, or older.
3933

4034
**STATUS:** 99% functional and live. Enjoy! (There may be the occasional bug found. if so, please report it so we can get it resolved.)

docs/Card-Images.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
# About
2-
32
Card images are assets used to represent the real cards in game. You DO NOT need images to play forge, however representing real cards is a nice ability forge provides. These images can be any image set you like, or custom images too.
43

54
Primarily there are two types of images you'll care about; cards, and tokens.
@@ -13,17 +12,14 @@ A deck may explicitly define the edition and art variant of each card it include
1312
Card images are cleared from memory cache when switching screens and between games.
1413

1514
# Downloading
16-
1715
Due to charges in Forges hosting and scryfall terms you can no longer predownload card images. Turn on auto download in forge to download card images when first viewed.
1816

1917
## In Forge Auto Download:
20-
2118
**Download Missing Images - Setting**
2219
- This will download the images from the sources as the game requests the image in situ.
2320
- This can be useful if you don't want to have copies of every card... You can do small pre-caching by loading your decks in the deck editor prior to playing to download just those images.
2421

2522
## Bulk Download Sites: (Not in game)
26-
2723
- [http://download.austeregrim.net](http://download.austeregrim.net)
2824
- Note from user AustereGrim;
2925
> I provide my site for free for bulk downloading the entire image catalog. So you don't need to give those spam sites more advertising spots. If the server is loaded bandwidth is shared, right now it's not heavily used so please feel free to download the 4+gb zips, or the individual zips if you need sets. They are the images Kev has uploaded to my site, and the Zips are updated nightly automatically.
@@ -33,7 +29,6 @@ Due to charges in Forges hosting and scryfall terms you can no longer predownloa
3329
If you have an older Android device for increased performance or to save bandwidth it might be a good idea to use lower resolution images instead: https://www.slightlymagic.net/forum/viewtopic.php?f=15&t=29104
3430

3531
# Storage
36-
3732
Card images are stored in `pics/cards`, and tokens in `pics/tokens`, in the Cache folder for forge:
3833

3934
- **Windows** - `C:\Users\<username>\appdata\local\forge\Cache\`
@@ -45,9 +40,7 @@ Card images are stored in `pics/cards`, and tokens in `pics/tokens`, in the Cach
4540
- **MacOS** - `/Users/<username>/Library/caches/forge/`
4641
- Use `Command + Shift + .` to show hidden files.
4742

48-
4943
# Subfolders
50-
5144
If you don't care about the edition's version of cards, images can be stored in the root directory of the cards folder.
5245

5346
`/cache/pics/cards/`
@@ -57,7 +50,6 @@ If you want the edition's versions of the cards, they need to go under the editi
5750
`/cache/pics/cards/AFR` for example for Adventures in the Forgotten Realms.
5851

5952
# File Naming
60-
6153
**File Names:**
6254
- Cards file names follow a simple principle: `Card Name#.border.ext`
6355
- `Card Name` - Card Name with spaces.
@@ -112,4 +104,3 @@ burning hands1.fullborder.jpg
112104
burning hands2.fullborder.jpg
113105
```
114106
Forge will not see either of those, and will probably download the missing `burning hands.fullborder.jpg` for you. Similarly adding a 3rd black dragon `black dragon3.fullborder.jpg` will **not** work either.
115-

docs/Card-scripting-API/AbilityFactory.md

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,14 @@ Parameters:
132132
These can be used to chain effects together. However, for common cases many effects already support this directly, e.g. `PutCounter | Choices$``.
133133
Besides making the script shorter using such shortcuts usually also helps the AI making better use of the effect.
134134

135+
### ChooseColor
136+
137+
### ChooseGeneric
138+
139+
### ChooseNumber
140+
141+
### ChoosePlayer
142+
135143
### ChooseType
136144
This can be used when a player is asked to choose a card (sub)type.
137145

@@ -168,6 +176,8 @@ Parameters:
168176

169177
## Copies
170178

179+
### Clone
180+
171181
### CopyPermanent
172182
Copies a permanent.
173183

@@ -395,6 +405,8 @@ Usually you choose a player and that player has to sacrifice something of their
395405

396406
## Scry
397407

408+
## Surveil
409+
398410
## StoreSVar
399411

400412
## Tokens

0 commit comments

Comments
 (0)