Quenty / NevermoreEngine

ModuleScript loader with reusable and easy unified server-client modules for faster game development on Roblox
https://quenty.github.io/NevermoreEngine/
MIT License
421 stars 125 forks source link

docs: Update docs for latest loader & improve sections #510

Closed unrooot closed 1 month ago

unrooot commented 1 month ago

There have been a couple to the loader of changes over the past few months that modified the project initialization process and format. This PR updates those sections in the documentation as well as changing the wording in some sections to hopefully provide more clarity to new users for how to use the Loader and ServiceBag.

Notable changes:

I left design.md alone (besides updating the order) since it seemed mostly fine, with one exception: the "package types" section. It looked useful, however incomplete, so I wasn't able to assume what information should have been added there.

github-actions[bot] commented 1 month ago

:rocket: PR was released in @quenty/actionmanager@13.10.0, @quenty/adorneeboundingbox@8.10.0, @quenty/adorneedata@7.11.0, @quenty/adorneevalue@10.10.0, @quenty/animationprovider@11.8.0, @quenty/animations@8.10.0, @quenty/assetserviceutils@5.12.0, @quenty/attributeutils@14.10.0, @quenty/avatareditorutils@7.11.0, @quenty/basicpane@13.10.0, @quenty/binder@14.11.0, @quenty/bindtocloseservice@8.10.0, @quenty/blend@12.10.0, @quenty/bodycolorsutils@7.10.0, @quenty/boundlinkutils@14.11.0, @quenty/brio@14.10.0, @quenty/buttondragmodel@1.8.0, @quenty/buttonhighlightmodel@14.10.0, @quenty/camera@14.12.0, @quenty/characterutils@12.10.0, @quenty/chatproviderservice@9.14.0, @quenty/clienttranslator@14.11.0, @quenty/clipcharacters@12.11.0, @quenty/cmdrservice@13.12.0, @quenty/collectionserviceutils@8.10.0, @quenty/color3utils@11.10.0, @quenty/colorpalette@10.11.0, @quenty/colorpicker@10.11.0, @quenty/conditions@10.12.0, @quenty/contentproviderutils@12.10.0, @quenty/cooldown@11.12.0, @quenty/coreguienabler@12.10.0, @quenty/counter@7.10.0, @quenty/datastore@13.12.0, @quenty/deathreport@10.12.0, @quenty/depthoffield@11.11.0, @quenty/elo@7.11.0, @quenty/equippedtracker@13.10.0, @quenty/firstpersoncharactertransparency@14.11.0, @quenty/flipbook@9.10.0, @quenty/friendutils@12.10.0, @quenty/gameconfig@12.14.0, @quenty/gameproductservice@14.14.0, @quenty/gamescalingutils@13.10.0, @quenty/genericscreenguiprovider@13.12.0, @quenty/hide@11.12.0, @quenty/highlight@10.11.0, @quenty/hintscoringutils@14.12.0, @quenty/humanoidspeed@12.12.0, @quenty/humanoidtracker@13.10.0, @quenty/idleservice@13.13.0, @quenty/ik@15.14.0, @quenty/influxdbclient@7.12.0, @quenty/inputkeymaputils@14.13.0, @quenty/inputmode@13.11.0, @quenty/inputobjectutils@4.11.0, @quenty/instanceutils@13.10.0, @quenty/linkutils@13.10.0, @quenty/lipsum@14.10.0, @quenty/localizedtextutils@12.10.0, @quenty/motor6d@7.12.0, @quenty/multipleclickutils@13.10.0, @quenty/observablecollection@12.10.0, @quenty/particleengine@13.11.0, @quenty/parttouchingcalculator@14.11.0, @quenty/permissionprovider@14.12.0, @quenty/physicsutils@8.10.0, @quenty/playerbinder@14.11.0, @quenty/playerhumanoidbinder@14.11.0, @quenty/playerinputmode@9.12.0, @quenty/playerutils@8.10.0, @quenty/promptqueue@1.9.0, @quenty/propertyvalue@7.10.0, @quenty/r15utils@13.10.0, @quenty/racketingropeconstraint@12.12.0, @quenty/radial-image@9.10.0, @quenty/ragdoll@15.13.0, @quenty/receiptprocessing@7.11.0, @quenty/remoting@12.11.0, @quenty/resetservice@11.12.0, @quenty/rigbuilderutils@10.12.0, @quenty/rogue-humanoid@10.12.0, @quenty/rogue-properties@11.12.0, @quenty/rx@13.10.0, @quenty/rxbinderutils@14.11.0, @quenty/rxsignal@7.10.0, @quenty/scoredactionservice@16.14.0, @quenty/screenshothudservice@7.11.0, @quenty/seatutils@7.11.0, @quenty/secrets@7.13.0, @quenty/selectionutils@8.10.0, @quenty/settings-inputkeymap@10.15.0, @quenty/settings@11.13.0, @quenty/snackbar@11.12.0, @quenty/softshutdown@9.13.0, @quenty/soundgroup@1.10.0, @quenty/soundplayer@7.11.0, @quenty/spawning@10.12.0, @quenty/sprites@13.9.0, @quenty/statestack@14.11.0, @quenty/teamtracker@13.10.0, @quenty/teamutils@10.10.0, @quenty/teleportserviceutils@9.10.0, @quenty/templateprovider@11.8.0, @quenty/textboxutils@7.10.0, @quenty/textfilterservice@13.11.0, @quenty/textserviceutils@13.10.0, @quenty/tie@10.12.0, @quenty/timedtween@7.10.0, @quenty/timesyncservice@13.11.0, @quenty/transitionmodel@7.11.0, @quenty/uiobjectutils@6.9.0, @quenty/undostack@7.10.0, @quenty/userserviceutils@9.11.0, @quenty/valuebaseutils@13.10.0, @quenty/valueobject@13.10.0, @quenty/viewport@11.13.0 :rocket: