You've already forked MenuGraphr
mirror of
https://github.com/FullScreenShenanigans/MenuGraphr.git
synced 2026-04-28 13:02:13 -07:00
.github
This commit is contained in:
Josh Goldberg
@@ -0,0 +1,51 @@
|
||||
<!--
|
||||
😍 Hi there! 😍
|
||||
Thanks for filing an issue on MenuGraphr! ✨
|
||||
|
||||
Before going through with this, 🙏 please 🙏 search through open issues to make sure it hasn't already been filed.
|
||||
|
||||
If it hasn't, please also fill *either* the "Bug" or "Feature" templates and delete the rest: 👇
|
||||
-->
|
||||
|
||||
<!-- Bug Template:
|
||||
### Bug Summary
|
||||
|
||||
_(what's wrong?)_
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
_(instructions on how someone else can play through the game to cause the bug)_
|
||||
-->
|
||||
|
||||
<!-- Feature Template:
|
||||
### Feature Request
|
||||
|
||||
_(what do you want?)_
|
||||
_(be as detailed as possible!)_
|
||||
|
||||
<!--
|
||||
Bug example:
|
||||
|
||||
### Bug Summary
|
||||
|
||||
The player can still walk after a battle cutscene has started.
|
||||
|
||||
### Steps to Reproduce
|
||||
|
||||
1. Start a game with Pokemon in the player's party
|
||||
2. Trigger a battle with `FSP.battles.startBattle` (see docs/battles.md)
|
||||
3. Immediately try to walk - you can, but shouldn't be able to.
|
||||
-->
|
||||
|
||||
<!--
|
||||
Feature example:
|
||||
|
||||
### Feature Request
|
||||
|
||||
Can we get a mod that lets the player push people out of the way automtically?
|
||||
|
||||
When you're fast-forwarding through the game, it's annoying having to try to move around NPCs.
|
||||
I'd like it if we the player walking into them would push them out of the way without changing the player's velocity.
|
||||
|
||||
Bonus points if they get a little "!" on top of their head. That'd be cute.
|
||||
-->
|
||||
@@ -0,0 +1,23 @@
|
||||
<!--
|
||||
😍 Hi there! 😍
|
||||
Thanks for submitting a pull request to MenuGraphr! ✨
|
||||
|
||||
Please fill out the following: 👇
|
||||
-->
|
||||
|
||||
### Summary
|
||||
|
||||
<!-- _(what does your PR do?)_ -->
|
||||
|
||||
Fixes #_(issue number here)_
|
||||
|
||||
<!--
|
||||
For example:
|
||||
|
||||
### Summary
|
||||
|
||||
Stops the player from being able to walk after a battle starts.
|
||||
|
||||
Fixes #123
|
||||
-->
|
||||
|
||||
@@ -2,7 +2,6 @@ dist/
|
||||
docs/generated/
|
||||
test/
|
||||
node_modules/
|
||||
*.css
|
||||
*.d.ts
|
||||
*.js*
|
||||
!./*.js
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
<!-- {{Top}} -->
|
||||
<!-- Top -->
|
||||
# MenuGraphr
|
||||
[](https://greenkeeper.io/)
|
||||
[](https://travis-ci.org/FullScreenShenanigans/MenuGraphr)
|
||||
[](http://badge.fury.io/js/menugraphr)
|
||||
|
||||
In-game menu and dialog creation and management for GameStartr.
|
||||
<!-- {{/Top}} -->
|
||||
<!-- /Top -->
|
||||
|
||||
MenuGraphr automates creating in-game menus containing paragraphs or scrolling lists of text.
|
||||
Each menu has a unique name by which its globally identified as well as a rectangular position relative to its parent.
|
||||
@@ -158,7 +158,7 @@ menuGrapher.addMenuDialog("GeneralText", "Hello world!");
|
||||
menuGrapher.setActiveMenu("GeneralText");
|
||||
```
|
||||
|
||||
<!-- {{Development}} -->
|
||||
<!-- Development -->
|
||||
## Development
|
||||
|
||||
After [forking the repo from GitHub](https://help.github.com/articles/fork-a-repo/):
|
||||
@@ -184,14 +184,17 @@ Source files are written under `src/` in TypeScript and compile in-place to Java
|
||||
`npm run watch` will directly run the TypeScript compiler on source files in watch mode.
|
||||
Use it in the background while developing to keep the compiled files up-to-date.
|
||||
|
||||
### Running Tests
|
||||
#### Running Tests
|
||||
|
||||
```shell
|
||||
npm run test
|
||||
```
|
||||
|
||||
Test files are alongside source files under `src/` and named `*.test.ts?`.
|
||||
Tests are written in [Mocha](https://github.com/mochajs/mocha) and [Chai](https://github.com/chaijs/chai).
|
||||
Their files are written using alongside source files under `src/` and named `*.test.ts?`.
|
||||
Whenever you add, remove, or rename a `*.test.t*` file under `src/`, `watch` will re-run `npm run test:setup` to regenerate the list of static test files in `test/index.html`.
|
||||
You can open that file in a browser to debug through the tests.
|
||||
`npm run test:run` will run that setup and execute tests using [Puppeteer](https://github.com/GoogleChrome/puppeteer).
|
||||
<!-- {{/Development}} -->
|
||||
|
||||
<!-- Maps -->
|
||||
<!-- /Maps -->
|
||||
<!-- /Development -->
|
||||
|
||||
+7
-7
@@ -16,7 +16,7 @@
|
||||
"@types/lodash": "^4.14.99",
|
||||
"@types/lolex": "^2.1.2",
|
||||
"@types/mocha": "^5.0.0",
|
||||
"@types/sinon": "^4.3.0",
|
||||
"@types/sinon": "^4.3.1",
|
||||
"@types/sinon-chai": "^2.7.29",
|
||||
"chai": "^4.1.2",
|
||||
"concurrently": "^3.5.1",
|
||||
@@ -28,15 +28,15 @@
|
||||
"requirejs": "^2.3.5",
|
||||
"run-for-every-file": "^1.1.0",
|
||||
"shenanigans-manager": "^0.2.26",
|
||||
"sinon": "^4.4.8",
|
||||
"sinon": "^4.5.0",
|
||||
"sinon-chai": "^3.0.0",
|
||||
"tslint": "5.9.1",
|
||||
"tsutils": "^2.25.1",
|
||||
"tsutils": "^2.26.1",
|
||||
"typedoc": "^0.11.1",
|
||||
"typescript": "^2.7.2",
|
||||
"typescript": "^2.8.1",
|
||||
"watch": "^1.0.2",
|
||||
"webpack": "^4.2.0",
|
||||
"webpack-cli": "^2.0.13"
|
||||
"webpack": "^4.5.0",
|
||||
"webpack-cli": "^2.0.14"
|
||||
},
|
||||
"license": "MIT",
|
||||
"name": "menugraphr",
|
||||
@@ -74,4 +74,4 @@
|
||||
},
|
||||
"types": "./src/index.d.ts",
|
||||
"version": "0.7.6"
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user