README & issue templates

Author: masked-rpgmaker

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,27 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: false
+contact_links:
+    - name: Comuns RPG Maker Discord server
+      url: https://discord.gg/TqzckXj
+      about: Please ask any questions here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

README.md

@@ -1,71 +1,55 @@
-![name of the image](https://github.com/niokasgami/Rpg-Maker-MZ-Typescript/blob/master/typescript.jpg)
-
-### Introductions
-This project document the whole MZ codebase allowing programmer to create plugins for rpg maker MZ using typescript.
-
-### How to use it?
-Just download the project and get the files from dist/libs 
-There's a totals of 7 files (including the external library)
-There's two way of using it : 
-
- by using the bundled files and calling the file globally or using the import features such as 
- ```js
-        import {Sprite} from "./lib/rmmz_core";
- ```
- 
- Please take now that in the forseen futur the file will be created as an distributable npm project and the core file will be declared as ambient module.
-
- ### Plugin Environment
- The plugin environment is still a work in progress but will be worked once the definitions files will be released. It will use rollup.js to build your plugins. An integration with gulp is also planned.
-
- ### Contributing
-You can contribute to the project by any means! 
-use to install all the dependencies.
-```npm
-    npm install 
- ```
-As the project is open to contribution there's specific rules to follow : 
-
-All class must be declared then exported 
- ```ts
-     declare class Dummy {} 
-     export {Dummy}
- ```
- due to the fact the project use rollup to bundle the files.
- All the appropriate files must be imported into the main file relative to the folder.
- i.e : rmmz_core.d.ts , rpg_object.d.ts etc
- the structure is at follow : 
- ```ts
- import {Class} from "./module";
-
-declare module "rmmz_core" {
-    export {
-        Class,
-    }
-}
- ```
-#### do and don't 
-
-Do references separated module directly from separated folder
-```ts 
- import {Game_Temp} from "../rpg_object/Game_Temp";
- ```
- In compiled file just using 
- ```ts 
- import {Game_Temp} from "../libs/rmmz_api";
- ```
- will work fine. 
-
-## build the files 
-Simply do rollup configfilename for the time being. In the futur their will be a NPM script command to just build the whole library in one call.
-
-## Roadmap
- * Documents all the classes.
- * Create RPG_Object, Manager , etc definitions files
- * Convert the project to a NPM project.
- * Create plugins helper.
- * Establish the plugin environment
- * Establish proper NPM command for ease the building.
- 
-## Licenses 
-MIT
+[source]: https://github.com/niokasgami/Rpg-Maker-MZ-Typescript
+
+![banner](./typescript.jpg)
+
+![Node.js Package](https://github.com/masked-rpgmaker/Rpg-Maker-MZ-Typescript/workflows/Node.js%20Package/badge.svg)
+
+
+# Introduction
+
+This project provides type definitions for the whole MZ codebase allowing the programmer to create plugins for rpg maker MZ using Typescript.
+
+This is a fork of [Nio Kasgami's repository][source], but adapted to be
+used as an NPM dependency. **All credit for the type definitions goes to Nio
+Kasgami and their contributors.** If you'd like to support the project, please
+head to the original repository.
+
+
+# Getting Started
+
+The project can be installed via NPM, both via the default NPM registry and the
+Github NPM Registry:
+
+    npm install rmmz@npm:@masked-rpgmaker/rpg-maker-mz-typescript
+
+All types are available from the top-level module:
+
+```ts
+import { DataManager, $gameParty, Game_Character } from 'rmmz';
+```
+
+Alternatively, you might import each module separately:
+
+```ts
+import * as core from 'rmmz/rmmz_core';
+import * as objects from 'rmmz/rmmz_objects';
+// ...
+```
+
+
+# Contributing
+
+If you're interested in providing new type definitions, please give preference
+to doing so on the [source repository][source] from Nio Kasgami. 
+
+We'll work to integrate any new type definitions added to their repository on
+our side.
+
+If you have any suggestions specific to this fork, please open an issue
+following our templates and/or open a pull request.
+
+
+# Terms of Use
+
+Please read the [license information](./LICENSE.md) for this repository.
+

lib/index.d.ts

@@ -4,7 +4,7 @@ export * from './rmmz_core';
 export * from './rmmz_managers';
 export * from './rmmz_objects';
 export * from './rmmz_sprites';
-export * from "./rmmz_windows";
+export * from './rmmz_windows';
 export * from './rmmz_scenes';
 
 export * from './main';