.prettierrc.toml

@@ -1,2 +0,0 @@
-lineWidth = 72
-proseWrap = "always"

LICENSE

@@ -1,674 +1,29 @@
-                    GNU GENERAL PUBLIC LICENSE
+BSD 3-Clause License, Modified
-                       Version 3, 29 June 2007
+
-
+Copyright (c) 2024, Youwen Wu
- Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+
- Everyone is permitted to copy and distribute verbatim copies
+Redistribution and use in binary forms, with or without
- of this license document, but changing it is not allowed.
+modification, are permitted provided that the following conditions are met:
-
+
-                            Preamble
+1. Redistributions in binary form must reproduce the above copyright notice,
-
+   this list of conditions and the following disclaimer in the documentation
-  The GNU General Public License is a free, copyleft license for
+   and/or other materials provided with the distribution.
-software and other kinds of works.
+
-
+2. Neither the name of the copyright holder nor the names of its
-  The licenses for most software and other practical works are designed
+   contributors may be used to endorse or promote products derived from
-to take away your freedom to share and change the works.  By contrast,
+   this software without specific prior written permission.
-the GNU General Public License is intended to guarantee your freedom to
+
-share and change all versions of a program--to make sure it remains free
+Redistribution and use of source code without explicit permission granted by the
-software for all its users.  We, the Free Software Foundation, use the
+Owner of this repository (Team 1280, The Ragin' C-Biscuits, San Ramon Valley 
-GNU General Public License for most of our software; it applies also to
+High School, and Youwen Wu) is strictly prohibited.
-any other work released this way by its authors.  You can apply it to
+
-your programs, too.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-  When we speak of free software, we are referring to freedom, not
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-price.  Our General Public Licenses are designed to make sure that you
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-have the freedom to distribute copies of free software (and charge for
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-them if you wish), that you receive source code or can get it if you
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-want it, that you can change the software or use pieces of it in new
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-free programs, and that you know you can do these things.
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-  To protect your rights, we need to prevent others from denying you
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-these rights or asking you to surrender the rights.  Therefore, you have
-certain responsibilities if you distribute copies of the software, or if
-you modify it: responsibilities to respect the freedom of others.
-
-  For example, if you distribute copies of such a program, whether
-gratis or for a fee, you must pass on to the recipients the same
-freedoms that you received.  You must make sure that they, too, receive
-or can get the source code.  And you must show them these terms so they
-know their rights.
-
-  Developers that use the GNU GPL protect your rights with two steps:
-(1) assert copyright on the software, and (2) offer you this License
-giving you legal permission to copy, distribute and/or modify it.
-
-  For the developers' and authors' protection, the GPL clearly explains
-that there is no warranty for this free software.  For both users' and
-authors' sake, the GPL requires that modified versions be marked as
-changed, so that their problems will not be attributed erroneously to
-authors of previous versions.
-
-  Some devices are designed to deny users access to install or run
-modified versions of the software inside them, although the manufacturer
-can do so.  This is fundamentally incompatible with the aim of
-protecting users' freedom to change the software.  The systematic
-pattern of such abuse occurs in the area of products for individuals to
-use, which is precisely where it is most unacceptable.  Therefore, we
-have designed this version of the GPL to prohibit the practice for those
-products.  If such problems arise substantially in other domains, we
-stand ready to extend this provision to those domains in future versions
-of the GPL, as needed to protect the freedom of users.
-
-  Finally, every program is threatened constantly by software patents.
-States should not allow patents to restrict development and use of
-software on general-purpose computers, but in those that do, we wish to
-avoid the special danger that patents applied to a free program could
-make it effectively proprietary.  To prevent this, the GPL assures that
-patents cannot be used to render the program non-free.
-
-  The precise terms and conditions for copying, distribution and
-modification follow.
-
-                       TERMS AND CONDITIONS
-
-  0. Definitions.
-
-  "This License" refers to version 3 of the GNU General Public License.
-
-  "Copyright" also means copyright-like laws that apply to other kinds of
-works, such as semiconductor masks.
-
-  "The Program" refers to any copyrightable work licensed under this
-License.  Each licensee is addressed as "you".  "Licensees" and
-"recipients" may be individuals or organizations.
-
-  To "modify" a work means to copy from or adapt all or part of the work
-in a fashion requiring copyright permission, other than the making of an
-exact copy.  The resulting work is called a "modified version" of the
-earlier work or a work "based on" the earlier work.
-
-  A "covered work" means either the unmodified Program or a work based
-on the Program.
-
-  To "propagate" a work means to do anything with it that, without
-permission, would make you directly or secondarily liable for
-infringement under applicable copyright law, except executing it on a
-computer or modifying a private copy.  Propagation includes copying,
-distribution (with or without modification), making available to the
-public, and in some countries other activities as well.
-
-  To "convey" a work means any kind of propagation that enables other
-parties to make or receive copies.  Mere interaction with a user through
-a computer network, with no transfer of a copy, is not conveying.
-
-  An interactive user interface displays "Appropriate Legal Notices"
-to the extent that it includes a convenient and prominently visible
-feature that (1) displays an appropriate copyright notice, and (2)
-tells the user that there is no warranty for the work (except to the
-extent that warranties are provided), that licensees may convey the
-work under this License, and how to view a copy of this License.  If
-the interface presents a list of user commands or options, such as a
-menu, a prominent item in the list meets this criterion.
-
-  1. Source Code.
-
-  The "source code" for a work means the preferred form of the work
-for making modifications to it.  "Object code" means any non-source
-form of a work.
-
-  A "Standard Interface" means an interface that either is an official
-standard defined by a recognized standards body, or, in the case of
-interfaces specified for a particular programming language, one that
-is widely used among developers working in that language.
-
-  The "System Libraries" of an executable work include anything, other
-than the work as a whole, that (a) is included in the normal form of
-packaging a Major Component, but which is not part of that Major
-Component, and (b) serves only to enable use of the work with that
-Major Component, or to implement a Standard Interface for which an
-implementation is available to the public in source code form.  A
-"Major Component", in this context, means a major essential component
-(kernel, window system, and so on) of the specific operating system
-(if any) on which the executable work runs, or a compiler used to
-produce the work, or an object code interpreter used to run it.
-
-  The "Corresponding Source" for a work in object code form means all
-the source code needed to generate, install, and (for an executable
-work) run the object code and to modify the work, including scripts to
-control those activities.  However, it does not include the work's
-System Libraries, or general-purpose tools or generally available free
-programs which are used unmodified in performing those activities but
-which are not part of the work.  For example, Corresponding Source
-includes interface definition files associated with source files for
-the work, and the source code for shared libraries and dynamically
-linked subprograms that the work is specifically designed to require,
-such as by intimate data communication or control flow between those
-subprograms and other parts of the work.
-
-  The Corresponding Source need not include anything that users
-can regenerate automatically from other parts of the Corresponding
-Source.
-
-  The Corresponding Source for a work in source code form is that
-same work.
-
-  2. Basic Permissions.
-
-  All rights granted under this License are granted for the term of
-copyright on the Program, and are irrevocable provided the stated
-conditions are met.  This License explicitly affirms your unlimited
-permission to run the unmodified Program.  The output from running a
-covered work is covered by this License only if the output, given its
-content, constitutes a covered work.  This License acknowledges your
-rights of fair use or other equivalent, as provided by copyright law.
-
-  You may make, run and propagate covered works that you do not
-convey, without conditions so long as your license otherwise remains
-in force.  You may convey covered works to others for the sole purpose
-of having them make modifications exclusively for you, or provide you
-with facilities for running those works, provided that you comply with
-the terms of this License in conveying all material for which you do
-not control copyright.  Those thus making or running the covered works
-for you must do so exclusively on your behalf, under your direction
-and control, on terms that prohibit them from making any copies of
-your copyrighted material outside their relationship with you.
-
-  Conveying under any other circumstances is permitted solely under
-the conditions stated below.  Sublicensing is not allowed; section 10
-makes it unnecessary.
-
-  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
-
-  No covered work shall be deemed part of an effective technological
-measure under any applicable law fulfilling obligations under article
-11 of the WIPO copyright treaty adopted on 20 December 1996, or
-similar laws prohibiting or restricting circumvention of such
-measures.
-
-  When you convey a covered work, you waive any legal power to forbid
-circumvention of technological measures to the extent such circumvention
-is effected by exercising rights under this License with respect to
-the covered work, and you disclaim any intention to limit operation or
-modification of the work as a means of enforcing, against the work's
-users, your or third parties' legal rights to forbid circumvention of
-technological measures.
-
-  4. Conveying Verbatim Copies.
-
-  You may convey verbatim copies of the Program's source code as you
-receive it, in any medium, provided that you conspicuously and
-appropriately publish on each copy an appropriate copyright notice;
-keep intact all notices stating that this License and any
-non-permissive terms added in accord with section 7 apply to the code;
-keep intact all notices of the absence of any warranty; and give all
-recipients a copy of this License along with the Program.
-
-  You may charge any price or no price for each copy that you convey,
-and you may offer support or warranty protection for a fee.
-
-  5. Conveying Modified Source Versions.
-
-  You may convey a work based on the Program, or the modifications to
-produce it from the Program, in the form of source code under the
-terms of section 4, provided that you also meet all of these conditions:
-
-    a) The work must carry prominent notices stating that you modified
-    it, and giving a relevant date.
-
-    b) The work must carry prominent notices stating that it is
-    released under this License and any conditions added under section
-    7.  This requirement modifies the requirement in section 4 to
-    "keep intact all notices".
-
-    c) You must license the entire work, as a whole, under this
-    License to anyone who comes into possession of a copy.  This
-    License will therefore apply, along with any applicable section 7
-    additional terms, to the whole of the work, and all its parts,
-    regardless of how they are packaged.  This License gives no
-    permission to license the work in any other way, but it does not
-    invalidate such permission if you have separately received it.
-
-    d) If the work has interactive user interfaces, each must display
-    Appropriate Legal Notices; however, if the Program has interactive
-    interfaces that do not display Appropriate Legal Notices, your
-    work need not make them do so.
-
-  A compilation of a covered work with other separate and independent
-works, which are not by their nature extensions of the covered work,
-and which are not combined with it such as to form a larger program,
-in or on a volume of a storage or distribution medium, is called an
-"aggregate" if the compilation and its resulting copyright are not
-used to limit the access or legal rights of the compilation's users
-beyond what the individual works permit.  Inclusion of a covered work
-in an aggregate does not cause this License to apply to the other
-parts of the aggregate.
-
-  6. Conveying Non-Source Forms.
-
-  You may convey a covered work in object code form under the terms
-of sections 4 and 5, provided that you also convey the
-machine-readable Corresponding Source under the terms of this License,
-in one of these ways:
-
-    a) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by the
-    Corresponding Source fixed on a durable physical medium
-    customarily used for software interchange.
-
-    b) Convey the object code in, or embodied in, a physical product
-    (including a physical distribution medium), accompanied by a
-    written offer, valid for at least three years and valid for as
-    long as you offer spare parts or customer support for that product
-    model, to give anyone who possesses the object code either (1) a
-    copy of the Corresponding Source for all the software in the
-    product that is covered by this License, on a durable physical
-    medium customarily used for software interchange, for a price no
-    more than your reasonable cost of physically performing this
-    conveying of source, or (2) access to copy the
-    Corresponding Source from a network server at no charge.
-
-    c) Convey individual copies of the object code with a copy of the
-    written offer to provide the Corresponding Source.  This
-    alternative is allowed only occasionally and noncommercially, and
-    only if you received the object code with such an offer, in accord
-    with subsection 6b.
-
-    d) Convey the object code by offering access from a designated
-    place (gratis or for a charge), and offer equivalent access to the
-    Corresponding Source in the same way through the same place at no
-    further charge.  You need not require recipients to copy the
-    Corresponding Source along with the object code.  If the place to
-    copy the object code is a network server, the Corresponding Source
-    may be on a different server (operated by you or a third party)
-    that supports equivalent copying facilities, provided you maintain
-    clear directions next to the object code saying where to find the
-    Corresponding Source.  Regardless of what server hosts the
-    Corresponding Source, you remain obligated to ensure that it is
-    available for as long as needed to satisfy these requirements.
-
-    e) Convey the object code using peer-to-peer transmission, provided
-    you inform other peers where the object code and Corresponding
-    Source of the work are being offered to the general public at no
-    charge under subsection 6d.
-
-  A separable portion of the object code, whose source code is excluded
-from the Corresponding Source as a System Library, need not be
-included in conveying the object code work.
-
-  A "User Product" is either (1) a "consumer product", which means any
-tangible personal property which is normally used for personal, family,
-or household purposes, or (2) anything designed or sold for incorporation
-into a dwelling.  In determining whether a product is a consumer product,
-doubtful cases shall be resolved in favor of coverage.  For a particular
-product received by a particular user, "normally used" refers to a
-typical or common use of that class of product, regardless of the status
-of the particular user or of the way in which the particular user
-actually uses, or expects or is expected to use, the product.  A product
-is a consumer product regardless of whether the product has substantial
-commercial, industrial or non-consumer uses, unless such uses represent
-the only significant mode of use of the product.
-
-  "Installation Information" for a User Product means any methods,
-procedures, authorization keys, or other information required to install
-and execute modified versions of a covered work in that User Product from
-a modified version of its Corresponding Source.  The information must
-suffice to ensure that the continued functioning of the modified object
-code is in no case prevented or interfered with solely because
-modification has been made.
-
-  If you convey an object code work under this section in, or with, or
-specifically for use in, a User Product, and the conveying occurs as
-part of a transaction in which the right of possession and use of the
-User Product is transferred to the recipient in perpetuity or for a
-fixed term (regardless of how the transaction is characterized), the
-Corresponding Source conveyed under this section must be accompanied
-by the Installation Information.  But this requirement does not apply
-if neither you nor any third party retains the ability to install
-modified object code on the User Product (for example, the work has
-been installed in ROM).
-
-  The requirement to provide Installation Information does not include a
-requirement to continue to provide support service, warranty, or updates
-for a work that has been modified or installed by the recipient, or for
-the User Product in which it has been modified or installed.  Access to a
-network may be denied when the modification itself materially and
-adversely affects the operation of the network or violates the rules and
-protocols for communication across the network.
-
-  Corresponding Source conveyed, and Installation Information provided,
-in accord with this section must be in a format that is publicly
-documented (and with an implementation available to the public in
-source code form), and must require no special password or key for
-unpacking, reading or copying.
-
-  7. Additional Terms.
-
-  "Additional permissions" are terms that supplement the terms of this
-License by making exceptions from one or more of its conditions.
-Additional permissions that are applicable to the entire Program shall
-be treated as though they were included in this License, to the extent
-that they are valid under applicable law.  If additional permissions
-apply only to part of the Program, that part may be used separately
-under those permissions, but the entire Program remains governed by
-this License without regard to the additional permissions.
-
-  When you convey a copy of a covered work, you may at your option
-remove any additional permissions from that copy, or from any part of
-it.  (Additional permissions may be written to require their own
-removal in certain cases when you modify the work.)  You may place
-additional permissions on material, added by you to a covered work,
-for which you have or can give appropriate copyright permission.
-
-  Notwithstanding any other provision of this License, for material you
-add to a covered work, you may (if authorized by the copyright holders of
-that material) supplement the terms of this License with terms:
-
-    a) Disclaiming warranty or limiting liability differently from the
-    terms of sections 15 and 16 of this License; or
-
-    b) Requiring preservation of specified reasonable legal notices or
-    author attributions in that material or in the Appropriate Legal
-    Notices displayed by works containing it; or
-
-    c) Prohibiting misrepresentation of the origin of that material, or
-    requiring that modified versions of such material be marked in
-    reasonable ways as different from the original version; or
-
-    d) Limiting the use for publicity purposes of names of licensors or
-    authors of the material; or
-
-    e) Declining to grant rights under trademark law for use of some
-    trade names, trademarks, or service marks; or
-
-    f) Requiring indemnification of licensors and authors of that
-    material by anyone who conveys the material (or modified versions of
-    it) with contractual assumptions of liability to the recipient, for
-    any liability that these contractual assumptions directly impose on
-    those licensors and authors.
-
-  All other non-permissive additional terms are considered "further
-restrictions" within the meaning of section 10.  If the Program as you
-received it, or any part of it, contains a notice stating that it is
-governed by this License along with a term that is a further
-restriction, you may remove that term.  If a license document contains
-a further restriction but permits relicensing or conveying under this
-License, you may add to a covered work material governed by the terms
-of that license document, provided that the further restriction does
-not survive such relicensing or conveying.
-
-  If you add terms to a covered work in accord with this section, you
-must place, in the relevant source files, a statement of the
-additional terms that apply to those files, or a notice indicating
-where to find the applicable terms.
-
-  Additional terms, permissive or non-permissive, may be stated in the
-form of a separately written license, or stated as exceptions;
-the above requirements apply either way.
-
-  8. Termination.
-
-  You may not propagate or modify a covered work except as expressly
-provided under this License.  Any attempt otherwise to propagate or
-modify it is void, and will automatically terminate your rights under
-this License (including any patent licenses granted under the third
-paragraph of section 11).
-
-  However, if you cease all violation of this License, then your
-license from a particular copyright holder is reinstated (a)
-provisionally, unless and until the copyright holder explicitly and
-finally terminates your license, and (b) permanently, if the copyright
-holder fails to notify you of the violation by some reasonable means
-prior to 60 days after the cessation.
-
-  Moreover, your license from a particular copyright holder is
-reinstated permanently if the copyright holder notifies you of the
-violation by some reasonable means, this is the first time you have
-received notice of violation of this License (for any work) from that
-copyright holder, and you cure the violation prior to 30 days after
-your receipt of the notice.
-
-  Termination of your rights under this section does not terminate the
-licenses of parties who have received copies or rights from you under
-this License.  If your rights have been terminated and not permanently
-reinstated, you do not qualify to receive new licenses for the same
-material under section 10.
-
-  9. Acceptance Not Required for Having Copies.
-
-  You are not required to accept this License in order to receive or
-run a copy of the Program.  Ancillary propagation of a covered work
-occurring solely as a consequence of using peer-to-peer transmission
-to receive a copy likewise does not require acceptance.  However,
-nothing other than this License grants you permission to propagate or
-modify any covered work.  These actions infringe copyright if you do
-not accept this License.  Therefore, by modifying or propagating a
-covered work, you indicate your acceptance of this License to do so.
-
-  10. Automatic Licensing of Downstream Recipients.
-
-  Each time you convey a covered work, the recipient automatically
-receives a license from the original licensors, to run, modify and
-propagate that work, subject to this License.  You are not responsible
-for enforcing compliance by third parties with this License.
-
-  An "entity transaction" is a transaction transferring control of an
-organization, or substantially all assets of one, or subdividing an
-organization, or merging organizations.  If propagation of a covered
-work results from an entity transaction, each party to that
-transaction who receives a copy of the work also receives whatever
-licenses to the work the party's predecessor in interest had or could
-give under the previous paragraph, plus a right to possession of the
-Corresponding Source of the work from the predecessor in interest, if
-the predecessor has it or can get it with reasonable efforts.
-
-  You may not impose any further restrictions on the exercise of the
-rights granted or affirmed under this License.  For example, you may
-not impose a license fee, royalty, or other charge for exercise of
-rights granted under this License, and you may not initiate litigation
-(including a cross-claim or counterclaim in a lawsuit) alleging that
-any patent claim is infringed by making, using, selling, offering for
-sale, or importing the Program or any portion of it.
-
-  11. Patents.
-
-  A "contributor" is a copyright holder who authorizes use under this
-License of the Program or a work on which the Program is based.  The
-work thus licensed is called the contributor's "contributor version".
-
-  A contributor's "essential patent claims" are all patent claims
-owned or controlled by the contributor, whether already acquired or
-hereafter acquired, that would be infringed by some manner, permitted
-by this License, of making, using, or selling its contributor version,
-but do not include claims that would be infringed only as a
-consequence of further modification of the contributor version.  For
-purposes of this definition, "control" includes the right to grant
-patent sublicenses in a manner consistent with the requirements of
-this License.
-
-  Each contributor grants you a non-exclusive, worldwide, royalty-free
-patent license under the contributor's essential patent claims, to
-make, use, sell, offer for sale, import and otherwise run, modify and
-propagate the contents of its contributor version.
-
-  In the following three paragraphs, a "patent license" is any express
-agreement or commitment, however denominated, not to enforce a patent
-(such as an express permission to practice a patent or covenant not to
-sue for patent infringement).  To "grant" such a patent license to a
-party means to make such an agreement or commitment not to enforce a
-patent against the party.
-
-  If you convey a covered work, knowingly relying on a patent license,
-and the Corresponding Source of the work is not available for anyone
-to copy, free of charge and under the terms of this License, through a
-publicly available network server or other readily accessible means,
-then you must either (1) cause the Corresponding Source to be so
-available, or (2) arrange to deprive yourself of the benefit of the
-patent license for this particular work, or (3) arrange, in a manner
-consistent with the requirements of this License, to extend the patent
-license to downstream recipients.  "Knowingly relying" means you have
-actual knowledge that, but for the patent license, your conveying the
-covered work in a country, or your recipient's use of the covered work
-in a country, would infringe one or more identifiable patents in that
-country that you have reason to believe are valid.
-
-  If, pursuant to or in connection with a single transaction or
-arrangement, you convey, or propagate by procuring conveyance of, a
-covered work, and grant a patent license to some of the parties
-receiving the covered work authorizing them to use, propagate, modify
-or convey a specific copy of the covered work, then the patent license
-you grant is automatically extended to all recipients of the covered
-work and works based on it.
-
-  A patent license is "discriminatory" if it does not include within
-the scope of its coverage, prohibits the exercise of, or is
-conditioned on the non-exercise of one or more of the rights that are
-specifically granted under this License.  You may not convey a covered
-work if you are a party to an arrangement with a third party that is
-in the business of distributing software, under which you make payment
-to the third party based on the extent of your activity of conveying
-the work, and under which the third party grants, to any of the
-parties who would receive the covered work from you, a discriminatory
-patent license (a) in connection with copies of the covered work
-conveyed by you (or copies made from those copies), or (b) primarily
-for and in connection with specific products or compilations that
-contain the covered work, unless you entered into that arrangement,
-or that patent license was granted, prior to 28 March 2007.
-
-  Nothing in this License shall be construed as excluding or limiting
-any implied license or other defenses to infringement that may
-otherwise be available to you under applicable patent law.
-
-  12. No Surrender of Others' Freedom.
-
-  If conditions are imposed on you (whether by court order, agreement or
-otherwise) that contradict the conditions of this License, they do not
-excuse you from the conditions of this License.  If you cannot convey a
-covered work so as to satisfy simultaneously your obligations under this
-License and any other pertinent obligations, then as a consequence you may
-not convey it at all.  For example, if you agree to terms that obligate you
-to collect a royalty for further conveying from those to whom you convey
-the Program, the only way you could satisfy both those terms and this
-License would be to refrain entirely from conveying the Program.
-
-  13. Use with the GNU Affero General Public License.
-
-  Notwithstanding any other provision of this License, you have
-permission to link or combine any covered work with a work licensed
-under version 3 of the GNU Affero General Public License into a single
-combined work, and to convey the resulting work.  The terms of this
-License will continue to apply to the part which is the covered work,
-but the special requirements of the GNU Affero General Public License,
-section 13, concerning interaction through a network will apply to the
-combination as such.
-
-  14. Revised Versions of this License.
-
-  The Free Software Foundation may publish revised and/or new versions of
-the GNU General Public License from time to time.  Such new versions will
-be similar in spirit to the present version, but may differ in detail to
-address new problems or concerns.
-
-  Each version is given a distinguishing version number.  If the
-Program specifies that a certain numbered version of the GNU General
-Public License "or any later version" applies to it, you have the
-option of following the terms and conditions either of that numbered
-version or of any later version published by the Free Software
-Foundation.  If the Program does not specify a version number of the
-GNU General Public License, you may choose any version ever published
-by the Free Software Foundation.
-
-  If the Program specifies that a proxy can decide which future
-versions of the GNU General Public License can be used, that proxy's
-public statement of acceptance of a version permanently authorizes you
-to choose that version for the Program.
-
-  Later license versions may give you additional or different
-permissions.  However, no additional obligations are imposed on any
-author or copyright holder as a result of your choosing to follow a
-later version.
-
-  15. Disclaimer of Warranty.
-
-  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
-APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
-HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
-OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
-THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
-PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
-IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
-ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
-
-  16. Limitation of Liability.
-
-  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
-THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
-GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
-USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
-DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
-PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
-EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
-
-  17. Interpretation of Sections 15 and 16.
-
-  If the disclaimer of warranty and limitation of liability provided
-above cannot be given local legal effect according to their terms,
-reviewing courts shall apply local law that most closely approximates
-an absolute waiver of all civil liability in connection with the
-Program, unless a warranty or assumption of liability accompanies a
-copy of the Program in return for a fee.
-
-                     END OF TERMS AND CONDITIONS
-
-            How to Apply These Terms to Your New Programs
-
-  If you develop a new program, and you want it to be of the greatest
-possible use to the public, the best way to achieve this is to make it
-free software which everyone can redistribute and change under these terms.
-
-  To do so, attach the following notices to the program.  It is safest
-to attach them to the start of each source file to most effectively
-state the exclusion of warranty; and each file should have at least
-the "copyright" line and a pointer to where the full notice is found.
-
-    jankboard
-    Copyright (C) 2024 Youwen Wu
-
-    This program is free software: you can redistribute it and/or modify
-    it under the terms of the GNU General Public License as published by
-    the Free Software Foundation, either version 3 of the License, or
-    (at your option) any later version.
-
-    This program is distributed in the hope that it will be useful,
-    but WITHOUT ANY WARRANTY; without even the implied warranty of
-    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-    GNU General Public License for more details.
-
-    You should have received a copy of the GNU General Public License
-    along with this program.  If not, see <https://www.gnu.org/licenses/>.
-
-Also add information on how to contact you by electronic and paper mail.
-
-  If the program does terminal interaction, make it output a short
-notice like this when it starts in an interactive mode:
-
-    jankboard  Copyright (C) 2024 Youwen Wu
-    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
-    This is free software, and you are welcome to redistribute it
-    under certain conditions; type `show c' for details.
-
-The hypothetical commands `show w' and `show c' should show the appropriate
-parts of the General Public License.  Of course, your program's commands
-might be different; for a GUI interface, you would use an "about box".
-
-  You should also get your employer (if you work as a programmer) or school,
-if any, to sign a "copyright disclaimer" for the program, if necessary.
-For more information on this, and how to apply and follow the GNU GPL, see
-<https://www.gnu.org/licenses/>.
-
-  The GNU General Public License does not permit incorporating your program
-into proprietary programs.  If your program is a subroutine library, you
-may consider it more useful to permit linking proprietary applications with
-the library.  If this is what you want to do, use the GNU Lesser General
-Public License instead of this License.  But first, please read
-<https://www.gnu.org/licenses/why-not-lgpl.html>.

README.md

@@ -1,80 +1,34 @@
-# Jankboard
+# Jankboard 2
 
-![build](https://github.com/youwen5/jankboard/actions/workflows/main.yml/badge.svg)
+[![maintainability status](https://api.codeclimate.com/v1/badges/4bedd567dbf60ec87164/maintainability)](https://codeclimate.com/repos/65dfbdc904f9ed00bbf381c8/maintainability)
+![build](https://github.com/couscousdude/jankboard-2/actions/workflows/main.yml/badge.svg)
+![build all platforms](https://github.com/couscousdude/jankboard-2/actions/workflows/publish-all.yml/badge.svg)
 [![https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg](https://good-labs.github.io/greater-good-affirmation/assets/images/badge.svg)](https://good-labs.github.io/greater-good-affirmation)
 
-This repository hosts the last version of the source code for the Jankboard
+Team 1280's custom, powerful, and opinionated dashboard for controlling FRC
-worked on by [me](https://github.com/youwen5).
+Robots, built with [Svelte](https://svelte.dev/) and
+[TypeScript](https://www.typescriptlang.org/), and powered by
+[Rust (Tauri)](https://tauri.app/).
 
-Jankboard is the fully custom control interface designed in-house by Team 1280
+Unlike Shuffleboard, which attempts to provide an unopinionated "blank slate"
-for the 2024 season of the
+with an easy to configure and modular environment for displaying robot data,
-[FIRST Robotics Competition](https://en.wikipedia.org/wiki/FIRST_Robotics_Competition).
+Jankboard 2 is purpose built for Team 1280's Swerve drivebase robots and their
-The FIRST Robotics Competition is an international high-school robotics
+needs. It's tightly integrated with our proprietary robot features, like
-competition which runs annually. Teams spend six weeks designing, prototyping,
+collision warning and detection, and displays robot drive modes.
-and building a robot to compete in each year's game. The goals for each game
-vary by year.
 
-Though this is a Team 1280 project, it's hosted on my GitHub account as I wrote
+Shuffleboard, while easy to set up, lacks the fine-grained adjustments and
-the vast majority of the code and retain rights to it via the
+customization which are afforded by a fully custom solution. The UI looks
-[license](./LICENSE). A small portion of this codebase was contributed by
+outdated and is quite ugly. In stark contrast, Jankboard's UI is reminiscient of
-[@quantum9innovation](https://github.com/quantum9Innovation/). I've released it
+and inspired by dashboards designed by car manufacturers, making it easy for the
-as free and open source software under the GPL v3, as permitted by Team 1280's
+driver to get the information they need at a glance, without squinting at
-policies for post-competition software stewardship.
+Shuffleboard's tiny and ugly UIs. It even includes a full 3D robot
+visualization, synced directly with the robot's movements in real life.
 
-The Jankboard is a fully functional control interface designed to be used with
+Even though the dashboard's layout and design are highly opinionated and not
-our 2024 robot. It is intended to work alongside the FRC Game Tools application,
+meant to be heavily modular, features can still be easily extended via a drop-in
-which is required by the rules to handle processing robot control inputs. The
+app system which supports easy drop-in app integration. Jankboard 2 ships with a
-Jankboard is a dashboard which receives the telemetry data from the robot and
+few apps by default, featuring a camera feed, robot settings configurator, and
-displays it for the driver. It also processes it to provide useful features. It
+even a music player and games.
-replaces the standard "Shuffleboard" dashboard program provided by FIRST, and
-has a much cleaner and purpose-built UI.
-
-Jankboard is built with [Tauri](https://tauri.app/), which is a framework for
-building desktop application with Rust and webviews. Unlike Electron, it
-leverages the platforms built-in web technologies (Chromium on Windows, WebKit
-on Linux and MacOS) to avoid shipping a massive bloated binary with a bundled
-browser. Our (my) choice of web framework is [Svelte](https://svelte.dev/), a
-modern framework with a compiler. To interface with and collect telemetry from
-the robot, a Rust backend implements the low-level networking and communication
-details and streams the received data back to the frontend UI. As soon as new
-data is received, the frontend is updated immediately. We found that this
-provided more than enough speed for our purposes, since the robot sends new
-telemetry at a rate of 10 Hz. We chose this tech stack because building
-beautiful and functional UIs is easiest with the Web, and it allowed us to
-rapidly build the application during our 6-week development period.
-
-<!-- prettier-ignore -->
-> [!IMPORTANT]
-> If you are interested in forking this project or utilizing portions of it for
-> your (personal or on behalf of your organization) use, please see
-> [the licensing section](#licensing) for a detailed explanation of what this
-> project's status as free software entails.
-
----
-
-<table>
-<tr><td><b>Table of Contents:</b></td></tr>
-
-  <tr>
-<td>
-
-<!--toc:start-->
-
-- [Jankboard](#jankboard)
-  - [Installation guide](#installation-guide)
-  - [A brief note on the name "Jankboard"](#a-brief-note-on-the-name-jankboard)
-  - [For developers](#for-developers)
-    - [Prerequisites](#prerequisites)
-    - [Installation steps](#installation-steps)
-      - [Some notes:](#some-notes)
-  - [Troubleshooting common issues](#troubleshooting-common-issues)
-  - [Licensing](#licensing)
-  <!--toc:end-->
-
-</tr>
-</table>
-
----
 
 ## Installation guide
 
@@ -86,58 +40,62 @@ release binaries for your system, follow the directions below in the
 periodically update the releases with new builds when we come out with stable
 versions, and we follow [semantic versioning](https://semver.org/).
 
-## A brief note on the name "Jankboard"
+## A brief footnote on the name "Jankboard 2"
 
 The name "Jankboard" comes from Team 1280's original attempt at creating a
 custom dashboard. Though it looked and functioned superficially similar to
-Jankboard, it was not designed with maintainability in mind and became
+Jankboard 2, it was not designed with maintainability in mind and became
 exceptionally difficult to extend and develop as the codebase became bloated.
-Jankboard is a version redesigned from the ground up with the goal of easy
+Jankboard 2 is a version redesigned from the ground up with the goal of easy
 maintainability and richer features. It contains both a completely rewritten
-frontend and backend, which have been improved in almost every possible way.
+frontend and backend, which have been improved in almost every possible way. You
+can view the original version at
+[its archived repository.](https://github.com/Team-1280/Jankboard-Super-Jank/tree/f42715f5ae1897e95ef15103b16ba6e764d2c0be)
 
 ## For developers
 
-If you would like to contribute to Jankboard, there's only a few simple steps to
+If you would like to contribute to Jankboard 2, there's only a few simple steps
-get the development build up and running. Please keep in mind that the following
+to get the development build up and running.
-is only necessary if you are building from source; the binaries have no external
-dependencies.
 
 ### Prerequisites
 
 - Rust and `cargo`. Check the [Rust docs](https://www.rust-lang.org/learn) for
-  more information.
+  more information. We recommend you install Rust using `rustup`. Keep in mind
+  that this is ONLY necessary for development, release binaries do not require
+  Rust.
 - `pnpm`, for installing dependencies and the `vite` development server.
-- NodeJS
+- Ideally, NodeJS, but it's technically not required as `pnpm` brings its own
+  node binary.
 
 ### Installation steps
 
-1. Clone the repository using your preferred method.
+1. Clone the repository. The `client` directory contains the vast majority of
-2. Enter the `client` directory. This is where the majority of the app's source
+   the source code for the desktop app, while the `splash-screen` directory
-   code lives.
+   contains the source code for the splash screen displayed before the app
-3. Run `pnpm install` to download all required NPM dependencies.
+   loads. You don't have to touch anything in `splash-screen` unless you want to
-4. To create a production build, run `pnpm tauri build`. This will use Cargo to
+   modify it, in which case check the README in `splash-screen` for more
-   fetch and build all the Rust dependencies, then compile the app and output an
-   executable for your platform in `target`.
-5. To launch a developer build with hot reloading and convenient debugging
-   features, run `pnpm tauri dev`.
-
-#### Some notes:
-
-- The `client` directory contains the vast majority of the source code for the
-  desktop app, while the `splash-screen` directory contains the source code for
-  the splash screen displayed before the app loads. You don't have to touch
-  anything in `splash-screen` unless you want to modify it, in which case check
-  the [README](./splash-screen/README.md) in `splash-screen` for more
    information.
-
+2. `cd` into the `client` folder. The configuration files and `package.json`,
-- Tauri cross-compilation is still in beta, so you should build targeting the
+   This is where stuff like `package.json` and configuration files for our
-  same OS you're currently running. For example, create Windows builds from
+   various tooling are housed. The `client/src-tauri` directory contains the
-  Windows. Check [the Tauri docs](https://tauri.app/v1/guides/building/) for
+   Rust source code and `cargo` configuration files for the backend that
-  more information. We also have some Github Actions set up to automatically
+   interfaces with the robot via Network Tables.
-  compile a production build for all platforms, but this is expensive (uses over
+3. Run `pnpm install` to install dependencies.
-  30 minutes of our quota), and should only be used for publishing new major
+4. To run the desktop app in developer mode (with automatic hot stateful reload
-  releases.
+   and other useful features like error reporting), make sure you're in the
+   `client` directory and run `pnpm run tauri dev`. This will install and build
+   the Rust dependencies via `cargo` and initialize the `vite` development
+   server for the frontend. Note that since this is basically just running the
+   `vite` development server and then connecting the Tauri webview to it, there
+   may be slightly inconsistent behavior in dev mode versus production mode.
+5. To create a production binary, run `pnpm run tauri build`. Tauri
+6. To create a production binary, run `pnpm run tauri build`. Tauri
+   cross-compilation is still in beta, so you should generally try to build
+   targeting the same OS you're currently running. Check
+   [the Tauri docs](https://tauri.app/v1/guides/building/) for more information.
+   We also have some Github Actions set up to automatically compile a production
+   build for all platforms, but this is expensive (uses over 30 minutes of our
+   quota), and should only be used for publishing new major releases.
 
 ## Troubleshooting common issues
 
@@ -145,37 +103,33 @@ dependencies.
   resolution, try opening your editor directly in the `client` directory so it
   picks up the `tsconfig.json` and uses the project's own TypeScript language
   server.
+- If you don't have access to a development environment that supports running
+  standalone executables (eg. Github Codespaces), you can try running
+  `pnpm run dev` instead of `pnpm run tauri dev`, which will open a development
+  server at `localhost:5173` with the frontend running in the web. However, app
+  behavior may be inconsistent and you will not get any features from the Rust
+  backend.
 
-## Licensing
+## Current progress and improvements over (original) Jankboard
 
-This project is released as free software under the terms of the
+- Layout, toasts/notifications, music player, and app system ported.
-[GNU General Public License](./LICENSE). What that entails for a developer
+- Toast and audio cue system is much more robust
-seeking to use portions of this codebase, or even the entirety of the codebase,
+- Transitions added almost everywhere to make things smoother
-for their own purposes, is the following:
+- Tauri app created successfully, currently still using Flask backend
+- Visualization vastly improved with Threlte (Three.js) powered 3D robot
+  simulation
+- Robot model ported successfully via massive optimization through polygon
+  decimation
+- Added settings app with options to disable certain features and developer
+  tools for testing
+- Created dynamic voice prompt system to support new languages very easily
+- Overhaul backend in Rust
+- Overhaul visualization (especially camera)
+- Added Vlad's voice lines (AT LAST)
 
-You are given the freedom (rights) to copy, modify, and distribute this
+## TODO
-software, in its entirety or just a portion of it, with or without modification,
-provided you meet the following requirements:
 
-- If you do make modifications to the software, you are required to release the
+- Camera cutout overlay
-  source code of your modifications, also under the terms of the GPL v3, **if
+- Overhaul audio player system
-  you are planning to distribute the software**. However, this is **not required
+- Further integrate telemetry (like GPWS, collision warning, etc)
-  if you are not planning to distribute it**. See below.
+- Finish re-creating / adding various voice alerts and sequences
-- You may modify or use it however you'd like personally or internally (within
-  an organization, like your robotics team), without releasing your changes or
-  code under the GPL. This means that if you make a custom dashboard based on
-  this code for your own robotics team, you do not have to release the code as
-  long as you are not planning to distribute your custom dashboard to other
-  robotics teams or publish it publicly on the internet. If you do intend to
-  distribute it, then you must release the modified source under the terms of
-  the GPL v3.
-  - We think that this is fair - if you intend to keep an internal private tool,
-    we should not stop you from doing so. However, if you intend to publish your
-    tool or share it with others, then you should also publish or share the
-    source code for the benefit of other developers and robotics teams, as we
-    have done here.
-
-See the full license text of the [GPL](./LICENSE) if you need further
-clarification. The above is simply an explanation of the license, if any
-conflicts between the above text and the license text arise, then the original
-license text takes precedence.

client/package.json

@@ -17,7 +17,6 @@
     "@tauri-apps/cli": "^1.5.10",
     "@tsconfig/svelte": "^5.0.2",
     "@types/howler": "^2.2.11",
-    "@types/konami-code-js": "^0.8.3",
     "@types/three": "^0.161.2",
     "autoprefixer": "^10.4.17",
     "postcss": "^8.4.35",
@@ -36,7 +35,6 @@
     "@threlte/extras": "^8.8.0",
     "camera-controls": "^2.8.3",
     "howler": "^2.2.4",
-    "konami-code-js": "^0.8.1",
     "material-icons": "^1.13.12",
     "material-symbols": "^0.15.0",
     "overlayscrollbars-svelte": "^0.5.3",

client/src-tauri/tauri.conf.json

@@ -8,7 +8,7 @@
   },
   "package": {
     "productName": "Jankboard 2",
-    "version": "0.3.0"
+    "version": "0.2.0"
   },
   "tauri": {
     "allowlist": {

client/src/App.svelte

@@ -12,7 +12,6 @@
   import { settingsStore } from './lib/stores/settingsStore'
   import getSettings from './lib/utils/getSettings'
   import hideSplashscreen from './lib/utils/hideSplashscreen'
-  import Cutouts from './lib/Dashboard/Cutouts/Cutouts.svelte'
 
   let activeApp: App = 'camera'
   // fake loading splash screen to look cool if the model loads too fast
@@ -79,9 +78,6 @@
   </div>
 </main>
 
-<!-- Camera cutouts -->
-<Cutouts show={activeApp !== 'camera'} />
-
 <!-- toast service -->
 <Toaster />
 
@@ -92,14 +88,11 @@
 
   .infotainment-container {
     background-image: url('./assets/wallpaper.jpg');
-    background-repeat: repeat-y;
+    background-repeat: no-repeat;
     background-size: cover;
     /* hide scrollbar */
     -ms-overflow-style: none;
     scrollbar-width: none;
-    background-position: top right;
-    width: 65vw;
-    height: 100vh;
   }
 
   .infotainment-container::-webkit-scrollbar {

client/src/globals.d.ts

@@ -1,11 +1,3 @@
-declare module 'konami-code-js' {
-  export default class KonamiCode {
-    constructor(options: any = {})
-    setCallback: (callback: () => void) => void
-    disable: () => void
-  }
-}
-
 type Gear = 'park' | 'reverse' | 'neutral' | 'low' | 'auto' | 'drive'
 
 type Mode = 'chill' | 'ludicrous' | 'cruise'

client/src/lib/Apps/Camera/Camera.svelte

@@ -1,16 +1,15 @@
 <script lang="ts">
   import AppContainer from '../AppContainer.svelte'
   import CameraContainer from './CameraContainer.svelte'
-  import { settingsStore } from '../../stores/settingsStore'
 </script>
 
 <AppContainer
-  class="px-10 py-20 flex gap-8 w-full backdrop-blur-lg justify-center h-full rounded-3xl shadow-md bg-slate-300 bg-opacity-30"
+  class="px-10 py-20 flex gap-4 w-full backdrop-blur-lg justify-center h-full rounded-3xl shadow-md bg-slate-300 bg-opacity-30"
 >
   <div class="my-auto">
-    <CameraContainer cameraUrl={$settingsStore.frontCameraAddr} />
+    <CameraContainer cameraUrl="camera_url_here" />
   </div>
   <div class="my-auto">
-    <CameraContainer cameraUrl={$settingsStore.rearCameraAddr} />
+    <CameraContainer cameraUrl="camera_url_here" />
   </div>
 </AppContainer>

client/src/lib/Apps/Camera/CameraContainer.svelte

@@ -7,19 +7,10 @@
  -->
 <script lang="ts">
   export let cameraUrl: string
-
-  let feed: HTMLImageElement
-  let placeholder: HTMLDivElement
-
-  $: {
-    if (feed && placeholder) {
-      placeholder.style.width = `${feed.clientWidth}px`
-      placeholder.style.height = `${feed.clientHeight}px`
-    }
-  }
 </script>
 
 <div>
+  <!-- svelte-ignore a11y-missing-attribute -->
   <div class="grid">
     <img
       src={cameraUrl}
@@ -27,11 +18,9 @@
       height="400px"
       class="rounded-xl shadow-md layer1 z-10"
       alt="⠀"
-      bind:this={feed}
     />
     <div
-      class="rounded-xl shadow-md bg-neutral-300 animate-pulse layer2"
+      class="w-[400px] h-[400px] rounded-xl shadow-md bg-neutral-300 animate-pulse layer2"
-      bind:this={placeholder}
     />
   </div>
 </div>

client/src/lib/Apps/Settings/Settings.svelte

@@ -5,11 +5,8 @@
   import SettingsSelector from './SettingsSelector.svelte'
   import SettingsInput from './SettingsInput.svelte'
   import SettingsToggle from './SettingsToggle.svelte'
-  import KonamiCode from 'konami-code-js'
-  import { onMount } from 'svelte'
-  import { fly } from 'svelte/transition'
 
-  settingsStore.subscribe(async (value) => {
+  settingsStore.subscribe(async value => {
     window.localStorage.setItem('settings', JSON.stringify(value))
   })
 
@@ -18,71 +15,25 @@
     settingsStore.reset()
     Notifications.success('Settings reset! Refresh for all changes to apply.')
   }
-
-  let unlockSecret = false
-
-  onMount(() => {
-    const kc = new KonamiCode()
-    kc.setCallback(() => {
-      kc.disable()
-      unlockSecret = true
-    })
-  })
 </script>
 
 <AppContainer
-  class="flex flex-col gap-6 bg-blue-200 bg-opacity-25 backdrop-blur-xl media-background rounded-3xl flex-wrap px-10 py-20 transition-all"
+  class="flex gap-6 bg-blue-200 bg-opacity-25 backdrop-blur-xl media-background rounded-3xl flex-wrap px-10 py-20"
 >
   <h1 class="text-5xl font-medium text-slate-100 basis-full">Settings</h1>
   <p class="text-slate-300">Hover over setting names to see helpful tooltips</p>
-  <div class="flex flex-col gap-2">
   <h2 class="text-2xl font-medium text-slate-200 mt-4 basis-full">General</h2>
-    <ul>
+  <div class="flex flex-col gap-2">
-      <li>
     <SettingsToggle
       setting="disableAnnoyances"
       tooltip="Disable non-critical popups and audio cues."
       >Disable Annoyances</SettingsToggle
     >
-      </li>
-      <li>
-        <SettingsSelector
-          setting="voiceLang"
-          options={['en-US', 'en-RU', 'en-UK']}
-          tooltip="Selects the language/locale used for Jankboard voice prompts. Does not affect application language (ie. Jankboard itself will always be in English)."
-          >Voice Prompt Language</SettingsSelector
-        >
-      </li>
-    </ul>
-    <h2 class="text-2xl font-medium text-slate-200 mt-4 basis-full">
-      Camera Configuration
-    </h2>
-    <ul>
-      <li>
-        <SettingsInput
-          setting="frontCameraAddr"
-          tooltip="Set the IP address of the front-facing camera. Input in the format xxx.xxx.xxx.xxx:PORT (eg. 244.178.44.111:8080)"
-          width="16rem">Front Camera IP</SettingsInput
-        >
-      </li>
-      <li>
-        <SettingsInput
-          setting="rearCameraAddr"
-          tooltip="Set the IP address of the rear-facing camera. Input in the format xxx.xxx.xxx.xxx:PORT (eg. 244.178.44.111:8080)"
-          width="16rem">Rear Camera IP</SettingsInput
-        >
-      </li>
-    </ul>
-    <h2 class="text-2xl font-medium text-slate-200 mt-4 basis-full">Fun</h2>
-    <ul>
-      <li>
     <SettingsToggle
-          setting="sentry"
+      setting="goWoke"
-          tooltip="Sentry mode protects the robot and operator from foreign threats (doesn't actually do anything besides add extra voice prompts)"
+      tooltip="Disables content that could be perceived as offensive for PR and DEI purposes."
-          >Sentry Mode</SettingsToggle
+      >Go Woke</SettingsToggle
     >
-      </li>
-      <li>
     <SettingsInput
       setting="randomWeight"
       tooltip="Changes the likelihood of random events occurring (default: 1). Set to a decimal to lower probability and a number >= 1 to increase it."
@@ -90,24 +41,17 @@
     >
       RNG Weight
     </SettingsInput>
-      </li>
+    <SettingsSelector
-    </ul>
+      setting="voiceLang"
-    {#if unlockSecret}
+      options={['en-US', 'en-RU', 'en-UK']}
-      <div transition:fly={{ y: -100, duration: 200 }}>
+      tooltip="Selects the language/locale used for Jankboard voice prompts. Does not affect application language (ie. Jankboard itself will always be in English)."
-        <h2 class="text-2xl font-medium text-slate-200 mt-4 basis-full">
+      >Voice Prompt Language</SettingsSelector
-          Secret
+    >
-        </h2>
+    <SettingsToggle
-        <ul>
+      setting="sentry"
-          <li>
+      tooltip="Sentry mode protects the robot and operator from foreign threats."
-            <SettingsToggle
+      >Sentry Mode</SettingsToggle
-              setting="goWoke"
-              tooltip="Disables content that could be perceived as offensive for PR and DEI purposes."
-              >Go Woke</SettingsToggle
     >
-          </li>
-        </ul>
-      </div>
-    {/if}
     <button
       class="mt-10 px-4 py-2 bg-amber-600 hover:brightness-75 text-medium rounded-lg w-min"
       on:click={resetSettings}>Reset</button
@@ -119,11 +63,3 @@
     </footer>
   </div>
 </AppContainer>
-
-<div class="w-full h-24" />
-
-<style lang="postcss">
-  li {
-    @apply my-3;
-  }
-</style>

client/src/lib/Apps/Settings/SettingsInput.svelte

@@ -13,6 +13,7 @@
 
   const handleSubmit = async () => {
     await tick()
+    // @ts-expect-error
     settingsStore.update(setting, value)
   }
 

client/src/lib/Dashboard/Cutouts/ClosableCutout.svelte

@@ -1,32 +0,0 @@
-<!-- 
-  @component
-
-  An individual camera cutout that can be closed
-
-  @param src - The source URL of the camera feed
-  @param show - Whether or not to show the cutout
- -->
-<script lang="ts">
-  import { fly } from 'svelte/transition'
-
-  export let src: string
-  export let show: boolean = true
-
-  const closeCutout = () => {
-    show = false
-  }
-</script>
-
-{#if show}
-  <div
-    class="rounded-lg bg-white bg-opacity-20 backdrop-blur-xl p-4 relative"
-    out:fly={{ y: -50 }}
-  >
-    <button
-      class="absolute top-2 right-2 bg-white bg-opacity-20 backdrop-blur-md hover:brightness-75 rounded-lg pt-2 px-2 pb-1"
-      on:click={closeCutout}
-      ><span class="material-symbols-outlined">close</span></button
-    >
-    <img {src} alt="Front Camera" class="min-w-[300px] min-h-[300px]" />
-  </div>
-{/if}

client/src/lib/Dashboard/Cutouts/Cutouts.svelte

@@ -1,20 +0,0 @@
-<!-- 
-  @component
-
-  Camera cutout overlay that displays over the app
- -->
-
-<script lang="ts">
-  import { fly } from 'svelte/transition'
-  import { settingsStore } from '../../stores/settingsStore'
-  import ClosableCutout from './ClosableCutout.svelte'
-
-  export let show: boolean = false
-</script>
-
-{#if show}
-  <div class="fixed top-4 right-4 flex gap-4" transition:fly={{ y: -50 }}>
-    <ClosableCutout src={$settingsStore.frontCameraAddr} />
-    <ClosableCutout src={$settingsStore.rearCameraAddr} />
-  </div>
-{/if}

client/src/lib/Dashboard/Visualization/Scene.svelte

@@ -1,11 +1,3 @@
-<!-- 
-  @component
-  
-  Visualization scene for the robot. 
-  1:28in scale
-  aka 1:0.71m scale
- -->
-
 <script lang="ts">
   import { T, useTask } from '@threlte/core'
   import { Grid } from '@threlte/extras'
@@ -23,7 +15,7 @@
 
   const dispatch = createEventDispatcher()
 
-  const SPEED_MULTIPLIER = 3
+  const SPEED_MULTIPLIER = 4
   const axis = new Vector3(0, 1, 0)
 
   const follow = (delta: number) => {
@@ -113,7 +105,6 @@
     /* TODO: standardize a scale (meters : grid lengths) so we can have
     accurate positioning of sensor detected objects */
     // update position data for robot model
-    // Speed is reported in
     $mesh.position.x +=
       $telemetryReadonlyStore['chassis-y-speed'] * delta * SPEED_MULTIPLIER
     $mesh.position.z +=
@@ -144,10 +135,8 @@
 <T.AmbientLight color={'#f0f0f0'} intensity={0.1} />
 
 <RobotDecimated
-  scale={[9, 9, 9]}
+  scale={[10, 10, 10]}
   position.y={0}
-  position.x={-2.8}
-  position.z={2.8}
   on:create={({ ref }) => {
     // @ts-expect-error
     mesh.set(ref)
@@ -159,7 +148,7 @@
   sectionColor={'#ff3e00'}
   sectionThickness={1}
   bind:fadeDistance={gridFadeDistance}
-  cellSize={3}
+  cellSize={6}
   sectionSize={24}
   cellColor={'#cccccc'}
   infiniteGrid

client/src/lib/Sequences/sequences.ts

@@ -217,7 +217,7 @@ export const infotainmentBootupSequence = async () => {
   }
 
   if (!get(sequenceStore).initializationComplete) {
-    const unsubscribe = sequenceStore.subscribe(data => {
+    const unsubscribe = sequenceStore.subscribe((data) => {
       if (data.initializationComplete) {
         sequence()
         unsubscribe()
@@ -237,7 +237,7 @@ export const infotainmentBootupSequence = async () => {
  */
 const waitForInfotainmentBootup = (sequence: () => void) => {
   if (!get(sequenceStore).infotainmentStartedFirstTime) {
-    const unsubscribe = sequenceStore.subscribe(data => {
+    const unsubscribe = sequenceStore.subscribe((data) => {
       if (data.infotainmentStartedFirstTime) {
         sequence()
         unsubscribe()

client/src/lib/stores/settingsStore.ts

@@ -11,8 +11,6 @@ export interface SettingsStoreData {
   randomWeight: number
   voiceLang: SupportedLanguage
   sentry: boolean
-  frontCameraAddr: string
-  rearCameraAddr: string
 }
 
 export const defaults: SettingsStoreData = {
@@ -20,10 +18,8 @@ export const defaults: SettingsStoreData = {
   goWoke: true, // go woke (for showing parents or other officials where DEI has taken over), disables "offensive" sequences
   fastStartup: false, // skip the loading splash screen (for development purposes. Setting this from within the app has no effect.)
   randomWeight: 1, // the weight of random events (multiplied by the original probability)
-  voiceLang: 'en-UK', // locale-specific voice for alerts
+  voiceLang: 'en-US', // locale-specific voice for alerts
-  sentry: false, // protect the robot and operator from foreign threats
+  sentry: true, // protect the robot and operator from foreign threats
-  frontCameraAddr: '',
-  rearCameraAddr: '',
 }
 
 const createSequenceStore = () => {
@@ -34,7 +30,7 @@ const createSequenceStore = () => {
       data: keyof SettingsStoreData,
       newValue: SettingsStoreData[typeof data]
     ) => {
-      update(store => {
+      update((store) => {
         // @ts-expect-error
         store[data] = newValue
         return store

splash-screen/README.md

@@ -44,4 +44,3 @@ screen!**
    inlined.
 4. Rename this outputted `index.html` to `splashscreen.html`, and then move it
    into `/client/public`, replacing the existing `splashscreen.html`.
-   Note: the background image will not load in development since it's designed to load `/splash-screen.jpg` from the main app. Update the `splash-screen.jpg` image in `client/public` to change it.

splash-screen/src/App.svelte

@@ -3,7 +3,13 @@
 </script>
 
 <svelte:head>
-  <title>Jankboard 2</title>
+  <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
+  <link rel="icon" type="image/png" sizes="32x32" href="/favicon-32x32.png" />
+  <link rel="icon" type="image/png" sizes="16x16" href="/favicon-16x16.png" />
+  <link rel="manifest" href="/site.webmanifest" />
+  <link rel="mask-icon" href="/safari-pinned-tab.svg" color="#5bbad5" />
+  <meta name="msapplication-TileColor" content="#da532c" />
+  <meta name="theme-color" content="#ffffff" />
 </svelte:head>
 
 <Loading />

splash-screen/src/lib/Loading.svelte

@@ -1,9 +1,8 @@
 <script lang="ts">
-  import { fly } from 'svelte/transition'
+  import { blur, fade } from 'svelte/transition'
 
   import SvelteLogo from './SvelteLogo.svelte'
   import { onMount } from 'svelte'
-  import { cubicIn } from 'svelte/easing'
 
   let loadingStuck = false
 
@@ -16,23 +15,24 @@
 
 <div
   class="absolute w-screen h-screen flex justify-center items-center flex-col overflow-hidden select-none bg"
+  transition:blur={{ duration: 300, amount: 0.5 }}
 >
   <div class="max-w-64">
     <SvelteLogo />
   </div>
   {#if loadingStuck}
     <p
-      class="text-4xl text-slate-300 absolute bottom-20 animate-pulse font-medium"
+      class="text-5xl text-slate-300 absolute bottom-20 animate-pulse"
-      in:fly={{ duration: 150, y: 25, easing: cubicIn }}
+      transition:fade={{ duration: 300 }}
     >
-      Loading 3D assets...
+      Loading 3D assets...please wait
     </p>
   {/if}
 </div>
 
 <style lang="postcss">
   .bg {
-    background-image: url('/splash-screen.jpg');
+    background-image: url('../../assets/wallpaper.jpg');
     background-repeat: no-repeat;
     background-size: cover;
   }