Merge pull request #14 from ShiJbey/development

Development

.gitignore

@@ -260,11 +260,7 @@ dmypy.json
 cython_debug/
 
 ### VisualStudioCode ###
-.vscode/*
-!.vscode/settings.json
-!.vscode/tasks.json
-!.vscode/launch.json
-!.vscode/extensions.json
+.vscode/
 *.code-workspace
 
 # Local History for Visual Studio Code
@@ -282,6 +278,8 @@ cython_debug/
 **/.DS_Store
 # End of https://www.toptal.com/developers/gitignore/api/python,jupyternotebooks,visualstudiocode,pycharm
 
+samples/scratches/
+
 # Simulation output
 samples/*.json
 samples/*.csv
@@ -290,3 +288,10 @@ samples/*.csv
 # Docs NodeJS stuff
 node_modules/
 /docs/node_modules/
+
+# Removing configurations because of issues moving between platforms
+.vscode/
+.idea/
+
+# Profiling output
+*.prof

CHANGELOG.md

@@ -7,6 +7,44 @@ and this project adheres mostly to [Semantic Versioning](https://semver.org/spec
 There may be minor-version updates that contain breaking changes, but do not warrant
 incrementing to a completely new version number.
 
+## [0.10.0]
+
+**This update has breaking changes from version 0.9.x**
+
+- The package has been restructured again to prevent circular dependencies. Classes are
+  now separated into subpackages/modules by function. For example, all the component
+  classes are within `neighborly.components` all the factories are within
+  `neighborly.factories` and all the default systems are within `neighborly.systems`.
+- The default plugins under `neighborly.plugins.defaults.xxxx` have been restructured
+  to allow people to more easily include only the content they need. If you do not care
+  about the specific plugins, `neighborly.plugins.defaults.all` will import all the
+  default plugins into the simulation.
+- Content libraries are now static class instances.
+- GameObject prefabs should now be instantiated using the `GameObjectFactory` class
+  rather than using the Prefab-specific libraries (CharacterLibrary, BusinessLibrary,
+  and ResidenceLibrary).
+
+### Added
+
+- Content authoring `neighborly.decorators` for use in single file simulations.
+- `py.typed` stub file to remove PyRight warning about Neighborly missing type stubs
+- *SystemGroups* were added to allow better systems ordering. The simulation update loop
+  is now separated into 4 phases (initialization, early-update, update, and
+  late-update).
+- Utility-based behavior trees for goals
+- Event callback are called directly from GameObjects instead of via systems
+- Events are an integral part of the ECS
+-
+
+### Updated
+
+- Content loading functions no longer need the world instance passed when loading assets
+
+### Removed
+
+- Prefab-specific libraries (CharacterLibrary, BusinessLibrary, and ResidenceLibrary) and replaced
+  them with the `GameObjectFactory` static class that handles instantiating GameObjects from prefabs
+
 ## [0.9.5]
 
 - The entire package has been restructures as some modules have moved

LICENSE

@@ -1,6 +1,6 @@
 # MIT LICENSE
 
-Copyright 2022-2013 Shi Johnson-Bey <[email protected]>
+Copyright 2022-2023 Shi Johnson-Bey <[email protected]>
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this
 software and associated documentation files (the "Software"), to deal in the Software

MANIFEST.in

@@ -3,7 +3,9 @@ include CHANGELOG.md
 include CODE_OF_CONDUCT.md
 include README.md
 include MANIFEST.in
+include src/neighborly/py.typed
 graft src/neighborly/plugins/defaults/data/
+graft src/neighborly/plugins/defaults/data/names
 graft src/neighborly/plugins/talktown
 global-exclude *.py[co]
 global-exclude __pycache__