Skip to content

Commit

Permalink
Second try at fixing doc links
Browse files Browse the repository at this point in the history
  • Loading branch information
Rangi42 committed Mar 11, 2019
1 parent 7231dc1 commit 6289232
Show file tree
Hide file tree
Showing 10 changed files with 126 additions and 126 deletions.
12 changes: 6 additions & 6 deletions docs/battle_anim_commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Battle Animation Commands

Defined in [macros/scripts/battle_anims.asm](https://github.com/pret/pokecrystal/macros/scripts/battle_anims.asm) and [engine/battle_anims/anim_commands.asm:BattleAnimCommands](https://github.com/pret/pokecrystal/engine/battle_anims/anim_commands.asm).
Defined in [macros/scripts/battle_anims.asm](https://github.com/pret/pokecrystal/blob/master/macros/scripts/battle_anims.asm) and [engine/battle_anims/anim_commands.asm:BattleAnimCommands](https://github.com/pret/pokecrystal/blob/master/engine/battle_anims/anim_commands.asm).


## `$00``$CF`: <code>anim_wait <i>length</i></code>
Expand All @@ -14,7 +14,7 @@ Defined in [macros/scripts/battle_anims.asm](https://github.com/pret/pokecrystal

Spawns an *object* at coordinate (*x*, *y*).

- *object*: `ANIM_OBJ` constants (see [constants/battle_anim_constants.asm](https://github.com/pret/pokecrystal/constants/battle_anim_constants.asm))
- *object*: `ANIM_OBJ` constants (see [constants/battle_anim_constants.asm](https://github.com/pret/pokecrystal/blob/master/constants/battle_anim_constants.asm))
- *x*: the x position in pixels
- *y*: the y position in pixels
- *x_tile*: an added x position in tiles (8 pixels)
Expand Down Expand Up @@ -45,7 +45,7 @@ The y position also depends on the y offset defined by the object.

Loads 1-5 sets of graphics. Will overwrite any previously loaded sets.

- *gfx*: `ANIM_GFX` constants (see [constants/battle_anim_constants.asm](https://github.com/pret/pokecrystal/constants/battle_anim_constants.asm))
- *gfx*: `ANIM_GFX` constants (see [constants/battle_anim_constants.asm](https://github.com/pret/pokecrystal/blob/master/constants/battle_anim_constants.asm))

Caveats:
- These will override any currently-loaded GFX.
Expand Down Expand Up @@ -74,7 +74,7 @@ Objects are state machines. `anim_setobj` changes the state of an object.

Increments a bg effect's state.

- *bg_effect*: `ANIM_BG` constants (see [constants/battle_anim_constants.asm](https://github.com/pret/pokecrystal/constants/battle_anim_constants.asm))
- *bg_effect*: `ANIM_BG` constants (see [constants/battle_anim_constants.asm](https://github.com/pret/pokecrystal/blob/master/constants/battle_anim_constants.asm))

Since there can't be two of the same bg effect, the effect type is used. This is distinct from `anim_incobj`.

Expand All @@ -94,7 +94,7 @@ Caveats:

## `$DB`: `anim_checkpokeball`

Sets `BattleAnimVar` to the result of [GetPokeBallWobble](https://github.com/pret/pokecrystal/engine/battle_anims/pokeball_wobble.asm).
Sets `BattleAnimVar` to the result of [GetPokeBallWobble](https://github.com/pret/pokecrystal/blob/master/engine/battle_anims/pokeball_wobble.asm).


## `$DC`: `anim_transform`
Expand Down Expand Up @@ -179,7 +179,7 @@ Jumps to another script and decrements `param` until it reaches 0. Similar to `a

## `$F0`: <code>anim_bgeffect <i>bg_effect</i>, <i>unknown1</i>, <i>unknown2</i>, <i>unknown3</i></code>

- *bg_effect*: `ANIM_BG` constants (see [constants/battle_anim_constants.asm](https://github.com/pret/pokecrystal/constants/battle_anim_constants.asm))
- *bg_effect*: `ANIM_BG` constants (see [constants/battle_anim_constants.asm](https://github.com/pret/pokecrystal/blob/master/constants/battle_anim_constants.asm))


## `$F1`: <code>anim_bgp <i>colors</i></code>
Expand Down
132 changes: 66 additions & 66 deletions docs/bugs_and_glitches.md

Large diffs are not rendered by default.

62 changes: 31 additions & 31 deletions docs/design_flaws.md

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/event_commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Event Commands

Defined in [macros/scripts/events.asm](https://github.com/pret/pokecrystal/macros/scripts/events.asm) and [engine/overworld/scripting.asm:ScriptCommandTable](https://github.com/pret/pokecrystal/engine/overworld/scripting.asm).
Defined in [macros/scripts/events.asm](https://github.com/pret/pokecrystal/blob/master/macros/scripts/events.asm) and [engine/overworld/scripting.asm:ScriptCommandTable](https://github.com/pret/pokecrystal/blob/master/engine/overworld/scripting.asm).

Until this document is filled out, the [G/S Scripting Compendium](https://hax.iimarckus.org/files/scriptingcodes_eng.htm) has descriptions for most of these commands. It was written for G/S binary hacking and not Crystal assembly hacking, so it's not 100% accurate for pokecrystal.

Expand Down
24 changes: 12 additions & 12 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,28 @@
These pages are for documenting pieces of the [pokecrystal](https://github.com/pret/pokecrystal) disassembly project. For more information, please see its [README.md](https://github.com/pret/pokecrystal/README.md) and [wiki](https://github.com/pret/pokecrystal/wiki).
These pages are for documenting pieces of the [pokecrystal](https://github.com/pret/pokecrystal) disassembly project. For more information, please see its [README.md](https://github.com/pret/pokecrystal/blob/master/README.md) and [wiki](https://github.com/pret/pokecrystal/blob/master/wiki).


## Issues with the source code

- [bugs_and_glitches.md](https://github.com/pret/pokecrystal/docs/bugs_and_glitches.md)
- [design_flaws.md](https://github.com/pret/pokecrystal/docs/design_flaws.md)
- [bugs_and_glitches.md](https://github.com/pret/pokecrystal/blob/master/docs/bugs_and_glitches.md)
- [design_flaws.md](https://github.com/pret/pokecrystal/blob/master/docs/design_flaws.md)


## Map event scripts

- [map_event_scripts.md](https://github.com/pret/pokecrystal/docs/map_event_scripts.md)
- [event_commands.md](https://github.com/pret/pokecrystal/docs/event_commands.md)
- [movement_commands.md](https://github.com/pret/pokecrystal/docs/movement_commands.md)
- [text_commands.md](https://github.com/pret/pokecrystal/docs/text_commands.md)
- [map_event_scripts.md](https://github.com/pret/pokecrystal/blob/master/docs/map_event_scripts.md)
- [event_commands.md](https://github.com/pret/pokecrystal/blob/master/docs/event_commands.md)
- [movement_commands.md](https://github.com/pret/pokecrystal/blob/master/docs/movement_commands.md)
- [text_commands.md](https://github.com/pret/pokecrystal/blob/master/docs/text_commands.md)


## Other types of scripts

- [battle_anim_commands.md](https://github.com/pret/pokecrystal/docs/battle_anim_commands.md)
- [move_effect_commands.md](https://github.com/pret/pokecrystal/docs/move_effect_commands.md)
- [music_commands.md](https://github.com/pret/pokecrystal/docs/music_commands.md)
- [battle_anim_commands.md](https://github.com/pret/pokecrystal/blob/master/docs/battle_anim_commands.md)
- [move_effect_commands.md](https://github.com/pret/pokecrystal/blob/master/docs/move_effect_commands.md)
- [music_commands.md](https://github.com/pret/pokecrystal/blob/master/docs/music_commands.md)


## Other subsystems

- [pic_animations.md](https://github.com/pret/pokecrystal/docs/pic_animations.md)
- [menus.md](https://github.com/pret/pokecrystal/docs/menus.md)
- [pic_animations.md](https://github.com/pret/pokecrystal/blob/master/docs/pic_animations.md)
- [menus.md](https://github.com/pret/pokecrystal/blob/master/docs/menus.md)
2 changes: 1 addition & 1 deletion docs/move_effect_commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Move Effect Commands

Defined in [macros/scripts/battle_commands.asm](https://github.com/pret/pokecrystal/macros/scripts/battle_commands.asm) and [data/battle/effect_command_pointers.asm:BattleCommandPointers](https://github.com/pret/pokecrystal/data/battle/effect_command_pointers.asm).
Defined in [macros/scripts/battle_commands.asm](https://github.com/pret/pokecrystal/blob/master/macros/scripts/battle_commands.asm) and [data/battle/effect_command_pointers.asm:BattleCommandPointers](https://github.com/pret/pokecrystal/blob/master/data/battle/effect_command_pointers.asm).


## `$01`: `checkturn`
Expand Down
2 changes: 1 addition & 1 deletion docs/movement_commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Movement Commands

Defined in [macros/scripts/movement.asm](https://github.com/pret/pokecrystal/macros/scripts/movement.asm) and [engine/overworld/movement.asm:MovementPointers](https://github.com/pret/pokecrystal/engine/overworld/movement.asm).
Defined in [macros/scripts/movement.asm](https://github.com/pret/pokecrystal/blob/master/macros/scripts/movement.asm) and [engine/overworld/movement.asm:MovementPointers](https://github.com/pret/pokecrystal/blob/master/engine/overworld/movement.asm).


## `$00``$03`: <code>turn_head <i>direction</i></code>
Expand Down
4 changes: 2 additions & 2 deletions docs/music_commands.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Music Commands

Defined in [macros/scripts/audio.asm](https://github.com/pret/pokecrystal/macros/scripts/audio.asm) and [audio/engine.asm:MusicCommands](https://github.com/pret/pokecrystal/audio/engine.asm).
Defined in [macros/scripts/audio.asm](https://github.com/pret/pokecrystal/blob/master/macros/scripts/audio.asm) and [audio/engine.asm:MusicCommands](https://github.com/pret/pokecrystal/blob/master/audio/engine.asm).

*See also: [Sound Engine Commands](https://github.com/pret/pokecrystal/wiki/Sound-Engine-Commands)*
*See also: [Sound Engine Commands](https://github.com/pret/pokecrystal/blob/master/wiki/Sound-Engine-Commands)*


## <code>musicheader <i>n</i>, <i>index</i>, <i>address</i></code>
Expand Down
8 changes: 4 additions & 4 deletions docs/pic_animations.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Pic Animations

Defined in [macros/scripts/gfx_anims.asm](https://github.com/pret/pokecrystal/macros/scripts/gfx_anims.asm).
Defined in [macros/scripts/gfx_anims.asm](https://github.com/pret/pokecrystal/blob/master/macros/scripts/gfx_anims.asm).

Pic animations are assembled in 3 parts:

Expand All @@ -19,12 +19,12 @@ Pic animations are assembled in 3 parts:

Animation data is in these files:

- [gfx/pokemon/anims.asm](https://github.com/pret/pokecrystal/gfx/pokemon/anims.asm):
- [gfx/pokemon/anims.asm](https://github.com/pret/pokecrystal/blob/master/gfx/pokemon/anims.asm):
Main animations (played everywhere)

- [gfx/pokemon/idles.asm](https://github.com/pret/pokecrystal/gfx/pokemon/idles.asm):
- [gfx/pokemon/idles.asm](https://github.com/pret/pokecrystal/blob/master/gfx/pokemon/idles.asm):
Idle animations, appended to the main animation.
Used in the status screen (blinking, tail wags etc.)

- [gfx/pokemon/unown_anims.asm](https://github.com/pret/pokecrystal/gfx/pokemon/unown_anims.asm) and [gfx/pokemon/unown_idles.asm](https://github.com/pret/pokecrystal/gfx/pokemon/unown_idles.asm):
- [gfx/pokemon/unown_anims.asm](https://github.com/pret/pokecrystal/blob/master/gfx/pokemon/unown_anims.asm) and [gfx/pokemon/unown_idles.asm](https://github.com/pret/pokecrystal/blob/master/gfx/pokemon/unown_idles.asm):
Unown has its own animation data despite having an entry in the main tables.
4 changes: 2 additions & 2 deletions docs/text_commands.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Text Commands

Defined in [macros/scripts/text.asm](https://github.com/pret/pokecrystal/macros/scripts/text.asm) and [home/text.asm:TextCommands](https://github.com/pret/pokecrystal/home/text.asm).
Defined in [macros/scripts/text.asm](https://github.com/pret/pokecrystal/blob/master/macros/scripts/text.asm) and [home/text.asm:TextCommands](https://github.com/pret/pokecrystal/blob/master/home/text.asm).


## `$00`: `text_start`
Expand Down Expand Up @@ -108,7 +108,7 @@ Play `SFX_SLOT_MACHINE_START`.

## `$14`: <code>text_buffer <i>id</i></code>

Write text from one of the following addresses (listed in [data/text_buffers.asm](https://github.com/pret/pokecrystal/data/text_buffers.asm)):
Write text from one of the following addresses (listed in [data/text_buffers.asm](https://github.com/pret/pokecrystal/blob/master/data/text_buffers.asm)):

0. `StringBuffer3`
1. `StringBuffer4`
Expand Down

0 comments on commit 6289232

Please sign in to comment.