Initial setup

.gitignore

@@ -0,0 +1,7 @@
+# Rojo #
+########
+rojo.json
+
+# mkdocs #
+##########
+/site

LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

README.md

@@ -0,0 +1,20 @@
+**Nexus Instance** is a framework meant to simplify the
+creation of classes in Lua, both in terms of syntax and
+being able to have the context of "super". The framework
+includes a base `NexusObject` class, as well as a more
+powerful `NexusInstance` class to allow for locking
+of properties and a `Changed` event.
+
+## Documentation
+Documentation for the framework and utilities can be found
+on the [GitHub pages](https://thenexusavenger.github.io/Nexus-Instance)
+for this project. The [docs folder](docs) can also be used since it has all
+of the markdown files.
+
+## Contributing
+Both issues and pull requests are accepted for this project.
+More information can be found [here](docs/contributing.md).
+
+## License
+Nexus Instance is available under the terms of the Apache 
+Liscence 2.0. See [LICENSE](LICENSE) for details.

docs/contributing.md

@@ -0,0 +1,20 @@
+# Contributing
+Bugs and requests can be made through issues. Pull requests are
+open, but will only be accepted if they have the following:
+<br>1. A reason to be pulled.
+<br>2. Follow the existing coding standards (tabs, PascalCase, etc).
+<br>3. Have the appropriate unit tests as examples. This is mainly for new utilities.
+<br>4. Comments are included.
+
+## Pulling Into Studio
+The format of this repository is based on [Rojo by LPGhatguy](https://github.com/LPGhatguy/rojo).
+Any other tools that follow the same file structure will work.
+
+## Exporting From Studio
+No public tool is currently provided for exporting Rojo
+projects from Roblox Studio. "Nexus Project Syncer" currently
+exists as an internal tool but will require significant work
+done before it can be released. The end goal of that project
+will be to replace Rojo while still being compatible. This
+functionality is expected to be added to Rojo in the near
+future.

docs/getting-started/classes/nexusinstance.md

@@ -0,0 +1,45 @@
+# NexusInstance
+
+`NexusInstance` is an extension of `NexusObject` to add
+an event for changes to properties and locking properties.
+The documentation below is only for what is overriden or
+implemented by `NexusInstance`. Everything else from
+`NexusObject` is inherited.
+
+### `NexusInstance.ClassName`
+The class name of the object. By default, this will
+be `"NexusInstance"` and is locked by the constructor.
+
+### `NexusInstance.Changed`
+An `RBXScriptSignal` that is invoked when a property
+change is made. When a change is made, the signal is
+invoked with the first parameter of the callback being
+the name of the property that changed.
+
+### `NexusObject.new()`
+Creates an instance of `NexusInstance`. It isn't intended
+to be used since it should be extended.
+
+### `NexusInstance:LockProperty(PropertyName)`
+Locks a property from being modified. If changing the property
+is attempted, an error will be thrown saying `"PROPERTY_NAME is read-only."`
+When a property is locked, it can't be unlocked.
+
+### `NexusInstance:HidePropertyChanges(PropertyName)`
+Hides all changed signals from being fired for a given
+property. This is intended for internal states.
+
+!!! note
+    This function only prevents the changed signal for
+    `NexusObject.Changed`. Using `NexusInstance:GetPropertyChangedSignal(PropertyName)`
+    will bypass this, but it is only recommended for the
+    internal state.
+
+### `NexusInstance:HideNextPropertyChange(PropertyName)`
+Hides the next changed signal from being fired for a given 
+property. This is intended for cases where a `Changed`
+signal will invoke a change that causes a stack overflow.
+
+### `NexusInstance:GetPropertyChangedSignal(PropertyName)`
+Returns an `RBXScriptSignal` that is invoked when a specific
+property is changed.

docs/getting-started/classes/nexusobject.md

@@ -0,0 +1,64 @@
+# NexusObject
+
+`NexusObject` is the root object that is used for extending.
+It contains the least amount of functionality, with the rest
+expected to be implemented by extending the class. `NexusObject`
+may work in a vanilla Lua environment, but Roblox is the only
+environment it is validated for.
+
+### `NexusObject.ClassName`
+The class name of the object. By default, this will
+be `"NexusObject"`, but isn't locked.
+
+!!! note
+    If the class name isn't overriden, it will inherit
+    from the class it extends from.
+
+### `NexusObject.super`
+The super class of the object. If the object has called
+`NexusObject::InitializeSuper`, then `super` will reflect
+a partial instanciation of the class. If it isn't called,
+then `super` will represent the static class it inherits from.
+For `NexusObject`, this will be `nil` since it is the
+root class.
+
+### `NexusObject.new()`
+Creates an instance of `NexusObject`. It isn't intended
+to be used since it should be extended.
+
+### `NexusObject:__new()`
+Base constructor of `NexusObject`. When an object extends
+`NexusObject`, this function should be overriden by the
+constructor required for that class. For `NexusObject`,
+this function is empty.
+
+### `NexusObject:__extended(OtherObject)`
+Called after the constructor for `NexusObject::InitializeSuper`
+when a class (Lua table) extends the base object. The
+only intended use case is for where modifying
+the Lua Metatables is required. It can also be used to
+check if an extension implements a set of functions,
+but it isn't supported or tested for.
+!!! note
+    When this function is overriden, it isn't called
+    explicitly to the next super class. It is recommended to
+    have `self.super:__extended(OtherObject)` if this function
+    is overriden. If it isn't, this done implicitly.
+
+### `NexusObject:InitializeSuper(...)`
+Initializes the super class. The paramters given by `...`
+are passed into the constructor of the super class (`__new(...)`).
+It should be called in the constructor of the class.
+
+### `NexusObject:SetClassName(ClassName)`
+Sets the class name of the object. It should be called staticly
+(ex: `ExtendedClass:SetClassName("ClassName")`, not
+`self:SetClassName("ClassName")`).
+
+### `NexusObject:IsA(ClassName)`
+Returns if the object is or inherits from a class
+with the given class name.
+
+### `NexusObject:Extend()`
+Extends a class to allow for implementing properties and
+functions while inheriting the super class's behavior.