Skip to content

Commit

Permalink
Update community docs (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
LastTalon authored and jackTabsCode committed Jan 31, 2024
1 parent c33e5a3 commit 14ee7a5
Show file tree
Hide file tree
Showing 8 changed files with 316 additions and 3 deletions.
26 changes: 26 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
name: Bug report
about: Create a report to help us improve
title: ""
labels: bug
assignees: ""
---

## Description

A clear and concise description of what the bug is. Be sure this isn't a
[duplicate report](https://github.com/matter-ecs/matter/issues) (if it is,
contribute to the already opened bug report).

## Steps 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.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Feature request
about: Suggest an idea for this project
title: ""
labels: feature
assignees: ""
---

## Problem

A clear and concise description of what the problem is or what you would like to
do differently. If there is a related
[issue](https://github.com/matter-ecs/matter/issues), let us know here.

## Proposed solution

A clear and concise description of what you want to happen.

## Alternatives

A clear and concise description of any alternative solutions or features
you've considered or are currently using.
22 changes: 22 additions & 0 deletions .github/ISSUE_TEMPLATE/improvement_suggestion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
name: Improvement suggestion
about: A minor enhancement or quality of life improvement
title: ""
labels: improvement
assignees: ""
---

## Current behavior

A clear and concise description of the current behavior, and why you think it
can be enhanced. If there is a related
[issue](https://github.com/matter-ecs/matter/issues), let us know here.

## Proposed improvement

A clear and concise description of what you want to happen.

## Additional context

Provide any additional context or examples that can help us understand the
importance of this improvement.
17 changes: 17 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Proposed changes

A clear and concise description of what your changes are. Explain to
maintainers why we should accept your solution. Be sure to adhere to our
[contribution guidelines](https://github.com/matter-ecs/matter/blob/main/CONTRIBUTING.md).

## Related issues

Explain how this pull request relates to any relevant
[issues](https://github.com/matter-ecs/matter/issues). Bugs and features should
always have related issues.

## Additional comments

If the changes are particularly complex, elaborate here. You can start off
discussion by addressing any foreseen issues or questions with the changes,
and by explaining why you chose this solution.
75 changes: 72 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,24 @@
# Changelog
# Matter Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog][kac], and this project adheres to
[Semantic Versioning][semver].

[kac]: https://keepachangelog.com/en/1.1.0/
[semver]: https://semver.org/spec/v2.0.0.html

## [Unreleased]

## [0.7.0] - 2023-12-19

### Added

- Created a debugger configuration `Debugger.componentRefreshFrequency` to change the unique component list's refresh frequency.

### Changed
- Change `Matter.log` to return *nothing* as expected.

- Change `Matter.log` to return _nothing_ as expected.
- Exported Matter object is now read only, which prevents invalid mutations to it.
- Improve documentation for `Matter.useEvent`.
- Systems with both after and priority defined will error.
Expand All @@ -15,108 +28,164 @@
- Improve implementation of the debugger's mouse hover feature, which now supports debugging the player's character model.

### Fixed

- Fix the debugger not showing a system's widgets properly when switching from one to another.
- Fix slider debugger widget returning 0 when not being rendered.

## [0.6.2] - 2022-07-22

### Fixed

- Debugger no longer interferes with `queryChanged` in order to display it in the debugger view. Previously, this caused the storage to get reset. This feature may return in the future.

## [0.6.1] - 2022-07-10

### Added

- Added `Matter.log`, and a logs viewer per-system to the Matter debugger.
- Added error logging and inspection to the Matter debugger.
- Added Query inspection to the Matter debugger.

### Fixed

- Fixed bug with server-side debugger when game was in deferred events mode

## [0.6.0] - 2022-07-08

### Changed

- The first time you call `queryChanged`, all existing entities in the world that match the component are now returned as "new" change records. Previously, nothing was returned.
- Improved Debugger with highlight selections and tooltips.
- `Matter.useEvent` now supports events that have a `Connect`, `connect`, or an `on` method. Additionally, it also supports custom connection objects (returned by custom events), which have a `Destroy` or a `Disconnect` method, or are just a cleanup function.

### Fixed

- Debugger: Fixed bug with profiling when disabling a system and then closing the debugger
- Debugger: Fixed bug with system list automatic sizing

## [0.5.3] - 2022-07-05

### Added

- Added performance information to debugger
- Add World inspector to debugger

### Fixed

- Fix confusing error when a system yields inside a plasma context

## [0.5.2] - 2022-07-01

### Fixed

- Fixed debugger panel not scrolling.
- In the debugger panel, the module name is now used when function is not named.

## [0.5.1] - 2022-06-30

### Fixed

- Fix custom debugger widgets not using the Plasma instance the user passed in.

## [0.5.0] - 2022-06-30

### Added

- Added Matter debugger.

### Changed

- Middleware now receive event name as a second parameter

## [0.4.0] - 2022-06-25

### Changed

- Modifying the World while inside `World:query` can no longer cause iterator invalidation. All operations to World while inside a query are now safe. 🎉
- If you aren't using `Loop`, you must call `World:optimizeQueries` periodically (e.g., every frame)
- If a system stops calling `queryChanged`, its internal storage will now be cleaned up. It is no longer a requirement that a system calls `queryChanged` forever.
- `Matter.merge` (an undocumented function) now only accepts two parameters.

### Fixed

- `replaceSystem` now correctly works when other systems reference a system being reloaded in their `after` table
- If `spawnAt` is called with an entity ID that already exists, it now errors as expected.

## [0.3.0] - 2022-06-22

### Added

- Added `World:spawnAt` to spawn a new entity with a specified ID.
- Added `World:__iter` to allow iteration over all entities in the world the world from a for loop.
- Added `Loop:evictSystem(system)`, which removes a previously-scheduled system from the Loop. Evicting a system also cleans up any storage from hooks. This is intended to be used for hot reloading. Dynamically loading and unloading systems for gameplay logic is not recommended.
- Added `Loop:replaceSystem(before, after)`, which replaces an older version of a system with a newer version of the system. Internal system storage (which is used by hooks) will be moved to be associated with the new system. This is intended to be used for hot reloading.
- The Matter example game has been updated and adds support for both replication and hot reloading.

### Changed

- The first entity ID is now `1` instead of `0`
- Events that have no systems scheduled to run on them are no longer skipped upon calling `Loop:begin`.

### Fixed

- Old event listeners created by `useEvent` were not properly disconnected when the passed event changed after having been already created. The event parameter passed to useEvent is not intended to be dynamically changed, so an warning has been added when this happens.

## [0.2.0] - 2022-06-04

### Added

- Added a second parameter to `Matter.component`, which allows specifying default component data.
- Add `QueryResult:snapshot` to convert a `QueryResult` into an immutable list

### Changed

- `queryChanged` behavior has changed slightly: If an entity's storage was changed multiple times since your system last observed it, the `old` field in the `ChangeRecord` will be the last value your system observed the entity as having for that component, rather than what it was most recently changed from.
- World and Loop types are now exported (#9)
- Matter now uses both `__iter` and `__call` for iteration over `QueryResult`.
- Improved many error messages from World methods, including passing nil values or passing a Component instead of a Component instance.
- Removed dependency on Llama

### Fixed

- System error stack traces are now displayed properly (#12)
- `World:clear()` now correctly resets internal changed storage used by `queryChanged` (#13)

### Removed

- Additional query parameters to `queryChanged` have been removed. `queryChanged` now only takes one argument. If your code used these additional parameters, you can use `World:get(entityId, ComponentName)` to get a component, and use `continue` to skip iteration if it is not present.

## [0.1.2]- 2022-01-06

### Fixed

- Fix Loop sort by priority to sort properly

## [0.1.1] - 2022-01-05

### Fixed

- Fix accidental system yield error message in Loop

### Changed

- Accidentally yielding or erroring in a system does not prevent other systems from running.

## [0.1.0] - 2022-01-02

- Initial release
- Initial release

[unreleased]: https://github.com/matter-ecs/matter/compare/v0.7.0...HEAD
[0.7.0]: https://github.com/matter-ecs/matter/releases/tag/v0.7.0
[0.6.2]: https://github.com/matter-ecs/matter/releases/tag/v0.6.2
[0.6.1]: https://github.com/matter-ecs/matter/releases/tag/v0.6.1
[0.6.0]: https://github.com/matter-ecs/matter/releases/tag/v0.6.0
[0.5.3]: https://github.com/matter-ecs/matter/releases/tag/v0.5.3
[0.5.2]: https://github.com/matter-ecs/matter/releases/tag/v0.5.2
[0.5.1]: https://github.com/matter-ecs/matter/releases/tag/v0.5.1
[0.5.0]: https://github.com/matter-ecs/matter/releases/tag/v0.5.0
[0.4.0]: https://github.com/matter-ecs/matter/releases/tag/v0.4.0
[0.3.0]: https://github.com/matter-ecs/matter/releases/tag/v0.3.0
[0.2.0]: https://github.com/matter-ecs/matter/releases/tag/v0.2.0
[0.1.2]: https://github.com/matter-ecs/matter/releases/tag/v0.1.2
[0.1.1]: https://github.com/matter-ecs/matter/releases/tag/v0.1.1
[0.1.0]: https://github.com/matter-ecs/matter/releases/tag/v0.1.0
80 changes: 80 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, sex characteristics, gender identity and
expression, level of experience, education, socio-economic status, nationality,
personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, or to ban temporarily or permanently any
contributor for other behaviors that they deem inappropriate, threatening,
offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [[email protected]]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an
incident. Further details of specific enforcement policies may be posted
separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

[[email protected]]: mailto:[email protected]

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 1.4, available at
https://www.contributor-covenant.org/version/1/4/code-of-conduct.html

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq

[homepage]: https://www.contributor-covenant.org
Loading

0 comments on commit 14ee7a5

Please sign in to comment.