Commit Graph

138 Commits

Author SHA1 Message Date
Remy Oukaour d2725c3104 Allow italics/bold within inline code 2018-01-17 13:58:50 -05:00
Remy Oukaour 6d20cf3e80 "CryHeader" → "Cry"; "Cry" → "MonCry" 2018-01-16 23:47:45 -05:00
Remy Oukaour bf074f3598 map_header → map_def; map_header_2 → map_data 2018-01-16 23:25:00 -05:00
Remy Oukaour 9180362211 Move code out of gfx/ (close #474) 2018-01-15 11:06:32 -05:00
Remy Oukaour f2dde1f4ca Markdown formatting 2018-01-15 00:05:20 -05:00
Remy Oukaour 14c8cf5b48 Merge branch 'master' of https://github.com/mid-kid/pokecrystal (resolve PR #452)
# Conflicts:
#	data/player_names.asm
#	engine/battle/menu.asm
#	engine/billspc.asm
#	engine/billspctop.asm
#	engine/buy_sell_toss.asm
#	engine/decorations.asm
#	engine/delete_save_change_clock.asm
#	engine/events/buena.asm
#	engine/events/elevator.asm
#	engine/events/kurt.asm
#	engine/events/mom.asm
#	engine/events/move_tutor.asm
#	engine/events/pokecenter_pc.asm
#	engine/events/pokepic.asm
#	engine/events/std_scripts.asm
#	engine/events/unown_walls.asm
#	engine/init_gender.asm
#	engine/intro_menu.asm
#	engine/mail.asm
#	engine/main_menu.asm
#	engine/mart.asm
#	engine/menu_2.asm
#	engine/mon_menu.asm
#	engine/pack.asm
#	engine/slot_machine.asm
#	engine/start_menu.asm
#	home/menu.asm
#	maps/CeladonDeptStore6F.asm
#	maps/CeladonGameCornerPrizeRoom.asm
#	maps/DragonShrine.asm
#	maps/EarlsPokemonAcademy.asm
#	maps/GoldenrodCity.asm
#	maps/GoldenrodDeptStore6F.asm
#	maps/GoldenrodGameCorner.asm
#	maps/GoldenrodPokeComCenter2FMobile.asm
#	mobile/mobile_12.asm
#	mobile/mobile_12_2.asm
#	mobile/mobile_22.asm
#	mobile/mobile_22_2.asm
#	mobile/mobile_40.asm
#	mobile/mobile_45.asm
#	mobile/mobile_45_sprite_engine.asm
#	mobile/mobile_46.asm
#	mobile/mobile_5c.asm
#	mobile/mobile_5f.asm
#	mobile/mobile_menu.asm
2018-01-14 23:43:51 -05:00
mid-kid d38ed29a46 Added menu documentation
While slightly shitty, it's as complete as I'm able to get it. Any
improvements are welcome.
2018-01-14 12:08:49 +01:00
Remy Oukaour 5a3822fe86 Introduce callback, hiddenitem, conditional_event, and cmdqueue macros for map scripts 2018-01-13 00:47:38 -05:00
Remy Oukaour d83aefb30a Use more constants in scripts 2018-01-12 02:27:42 -05:00
Remy Oukaour e0088adb3f Other files belong in data/battle/ 2018-01-10 17:49:19 -05:00
Remy Oukaour 9af6d8d0f1 Split tilesets/ into gfx/tilesets and data/tilesets/ 2018-01-09 23:53:58 -05:00
Remy Oukaour bc83768d81 Tileset images are 128px wide 2018-01-03 02:02:15 -05:00
Remy Oukaour fbfda4551a Bold 2018-01-01 18:44:08 -05:00
Remy Oukaour 355acfcaeb Fix battle anim documentation 2018-01-01 14:08:08 -05:00
Remy Oukaour 2d0ed1159e Use constants for rBGPI+rOBPI auto-increment
Fix some documentation
2018-01-01 13:43:02 -05:00
yenatch 4ce75e8dfc Document some more battle animation commands 2018-01-01 04:40:15 -05:00
yenatch be46c0da41 fix markdown formatting in battle_anim_commands.md 2017-12-29 18:03:35 -05:00
yenatch c312cab0f0 Document some battle animation commands 2017-12-29 17:47:45 -05:00
yenatch cc5aeb8b87 Fix anim_obj x/y values
- negative values have no meaning
- left in optional tile x/y for backwards compatibility
2017-12-29 13:43:17 -05:00
Remy Oukaour 84e22eb578 Consistent (x, y) coordinate formatting in map scripts 2017-12-28 14:31:25 -05:00
Remy Oukaour ce795692d9 Correct comment 2017-12-28 14:10:46 -05:00
Remy Oukaour fe605b2fa7 Document the Magikarp bug fix from PR #443 2017-12-28 14:08:29 -05:00
Remy Oukaour 97dd40284b Document another Magikarp length bug. (to do: correct formula values) 2017-12-28 13:17:43 -05:00
Remy Oukaour b5ffbfe2af Specify which bugs are needed for backwards compatibility 2017-12-28 12:58:18 -05:00
Remy Oukaour 7167895612 Document another bug
Document fixes for design flaws
GetForestTreeFrame is more like a design flaw than a bug/glitch (though it's really just calling out humorously bad code)
2017-12-28 12:49:32 -05:00
Remy Oukaour 805474b0db as → are 2017-12-28 12:14:47 -05:00
Remy Oukaour 0ceee9696a Explain what bugs, glitches, and flaws are 2017-12-28 11:50:02 -05:00
Remy Oukaour fe92e4d848 Document design flaws 2017-12-28 11:28:23 -05:00
Remy Oukaour 7a4d641251 Remove redundant data/ filename prefixes 2017-12-27 01:29:15 -05:00
Remy Oukaour 86fd37af16 Move events/ to engine/events/ 2017-12-27 00:09:12 -05:00
Remy Oukaour 47e4f21e62 Keep memory map values in hardware_constants.asm 2017-12-26 23:18:05 -05:00
Remy Oukaour 5d229dcef2 Copy sram.asm's global start/end constants for wram.asm and vram.asm 2017-12-26 23:07:46 -05:00
Remy Oukaour c4a18b1329 Correct documentation
Split out text_constants.asm
2017-12-26 22:36:01 -05:00
Remy Oukaour dae16acd6f event/ → events/, and move some appropriate engine/ files there 2017-12-26 21:55:57 -05:00
Remy Oukaour 35a3a19fda Use "battle_anims" and "sprite_anims" for clarity, not just "anims" 2017-12-26 18:45:04 -05:00
Remy Oukaour b5417fafec Split battle/ into data/ and engine/ components 2017-12-26 17:47:05 -05:00
Remy Oukaour 85cded6ec5 Update docs 2017-12-26 13:10:12 -05:00
Remy Oukaour 7dd6c8c3b2 Clean up docs/music_commands.md formatting and link to old wiki page 2017-12-25 14:57:30 -05:00
Remy Oukaour c659823761 Copy @henrxv's anim_obj documentation to docs/move_anim_commands.md (closes #399) 2017-12-25 14:40:30 -05:00
Remy Oukaour 1ea988b8a4 Expand assembly documentation 2017-12-25 14:33:18 -05:00
Remy Oukaour e34e68095d Resolve #428: Use `HIGH(X)` and `LOW(X)` instead of `X / $100` and `X % $100` or `X >> 8` and `X & $ff` 2017-12-25 14:23:16 -05:00
yenatch c95b67dd71 fix markdown reference links 2017-12-24 21:27:20 -05:00
froggestspirit 0a853dc1d3 Music documentation 2017-12-24 21:01:26 -05:00
Remy Oukaour e80dba3915 Start documentation for assembly language
Note: Resolved #340, #381, and #393 previously.
2017-12-24 18:40:20 -05:00
Remy Oukaour 3e7f3bbeb6 s/number/scene/, and correct some documentation 2017-12-24 17:35:33 -05:00
Remy Oukaour ef9090b9a0 Update documentation to match renaming 2017-12-24 15:09:28 -05:00
Remy Oukaour c05b7f41dd Renaming: (fix #412)
- MapTriggers / maptrigger → SceneScripts / scene_script
- XYTriggers / xy_trigger → CoordEvents / coord_event
- Signposts / signpost → BGEvents / bg_event
- PersonEvents / person_event → ObjectEvents / object_event
2017-12-24 14:33:17 -05:00
Remy Oukaour 82a8228e67 Keep images within repo 2017-12-23 12:08:34 -05:00
Remy Oukaour 1ecbfc49f4 Correct directions 2017-12-22 18:01:06 -05:00
Remy Oukaour ae3bef5596 Document one more graphical mistake 2017-12-22 17:59:50 -05:00
Remy Oukaour 763bd48141 Document a graphical error 2017-12-22 17:52:34 -05:00
Remy Oukaour ff4d25eee3 Include bugfix in comments 2017-12-21 12:11:35 -05:00
Remy Oukaour 02609940db Document one more bug 2017-12-21 11:43:41 -05:00
Remy Oukaour 2fa1e97aeb Document two more bugs 2017-12-19 19:04:56 -05:00
Remy Oukaour 3ed016f9e0 Auto-label more map scripts 2017-12-17 20:17:30 -05:00
Remy Oukaour 2b6dd505c1 Document another bug
Remove an unused file
2017-12-15 01:01:57 -05:00
Remy Oukaour d334a331fa Correct `endturn` value 2017-12-15 00:54:45 -05:00
Remy Oukaour d6dc9351e9 Start documenting effect commands 2017-12-15 00:48:59 -05:00
Remy Oukaour 28aec67f6e Document one more bug/oversight
Move FleeMons table into data/
2017-12-15 00:05:53 -05:00
Remy Oukaour 9ba224e2e6 Document two more bugs 2017-12-14 21:45:35 -05:00
Remy Oukaour 232feca298 Consistent "(with <routine>) in <file>" phrasing 2017-12-14 19:07:06 -05:00
Remy Oukaour 68785d9996 Use absolute links within repository 2017-12-14 19:04:44 -05:00
Remy Oukaour c5d482df20 Document two more bugs found by Crystal_ 2017-12-14 16:28:16 -05:00
Remy Oukaour b17db9b8b5 Friend Ball happiness for boxed Pokémon is not a bug 2017-12-14 14:18:33 -05:00
Remy Oukaour 00f28bb8f4 Consistent **Fix:** notation 2017-12-13 16:52:13 -05:00
Remy Oukaour feef75c5df Document more bugs and glitches
Add a toc.py script to auto-generate tables of contents in Markdown files
2017-12-13 16:46:31 -05:00
Remy Oukaour 76ea57688e Add table of contents (might remove if it's too cumbersome to maintain) 2017-12-13 00:28:48 -05:00
Remy Oukaour cd88196b7f Missing close parenthesis 2017-12-12 23:07:35 -05:00
Remy Oukaour 138abd097d Document one more bug. 2017-12-12 23:05:30 -05:00
Remy Oukaour 10eb426e40 Document more bugs 2017-12-12 22:58:20 -05:00
Remy Oukaour c85587d973 Remove unused constant
Fix typo
2017-12-12 21:29:53 -05:00
Remy Oukaour 7748b20c27 GetForestTreeFrame is not technically a bug or glitch, but it's exceptional 2017-12-12 21:16:15 -05:00
Remy Oukaour 370839cad7 Keep the "Bugs and Glitches" name 2017-12-12 20:50:34 -05:00
Remy Oukaour ad620243d9 Fix `make compare` 2017-12-12 20:21:08 -05:00
Remy Oukaour 93c32e3580 Document bugs and glitches 2017-12-12 20:15:07 -05:00
Remy Oukaour f0ab091254 Add an FAQ, and ive a bit more detail in Windows install instructions 2017-12-12 18:50:39 -05:00
Remy Oukaour 8b501c19a6 Fix Markdown syntax 2017-12-12 13:57:14 -05:00
Remy Oukaour 33eb3c6af2 Start documentation for map callbacks. 2017-12-12 13:56:17 -05:00
Remy Oukaour 906d356e09 Fix relative links 2017-12-12 13:51:58 -05:00
Remy Oukaour 0b34c997d6 Add basic documentation for text commands. 2017-12-12 13:51:07 -05:00
Remy Oukaour 5b13a7a13b Identify more sprite-related constants
Start more documentation
2017-12-12 13:22:19 -05:00
Remy Oukaour c5675927fe Identify more sprite-related constants 2017-12-12 12:18:11 -05:00
Remy Oukaour 79873a1bfc Move pic animation documentation to docs/
Move growth rates to a data/ table
Name more SECTIONs
2017-12-11 23:44:29 -05:00
Remy Oukaour 265d36c6b8 Italicize variables in docs 2017-12-11 23:11:58 -05:00
Remy Oukaour fe9cb90049 Fix map script documentation formatting 2017-12-11 22:02:20 -05:00
Remy Oukaour 19a3d1b6e4 Fix Markdown formatting for example lines 2017-12-11 21:45:26 -05:00
Remy Oukaour 20f98e1403 Start documentation for map scripts 2017-12-11 21:40:21 -05:00
Remy Oukaour 11b9bcb9e5 Start a docs directory; documentation still needs to be written 2017-12-11 21:25:36 -05:00