hytopia 0.1.0

package/LICENSE.md

@@ -0,0 +1,69 @@
+## HYTOPIA LIMITED USE LICENSE
+
+This Limited Use License (the "License") governs your access to and use of certain software and assets provided by HYTOPIA ("HYTOPIA").
+
+By downloading, accessing, or using the accompanying software and materials—which may include data, datasets, images, models, audio, and documentation (collectively, the "Licensed Software")—you agree to be bound by the terms and conditions of this License. The term "you" refers to any individual or entity receiving a copy of the Licensed Software, whether directly from HYTOPIA or through another source.
+
+Accessing and using the Licensed Software may require you in the future to apply for and maintain an active registration and account with HYTOPIA. The use of such an account and associated services (collectively, the "Service") is governed by separate terms (the "Terms of Service").
+
+### 1. License Grant
+Subject to your complete and ongoing compliance with this License (including any applicable Terms of Service), HYTOPIA grants you a limited, non-exclusive, non-transferable, non-sublicensable, and revocable permission to access and use the Licensed Software during the License Term (defined below), in accordance with the documentation. This permission is granted solely for the following purposes (collectively, the "Purpose"):
+
+1. Internally incorporating the Licensed Software into your larger applications for deployment through the HYTOPIA platform.
+1. Using it in connection with HYTOPIA products and services for which the Licensed Software was designed.
+You may collaborate with other developers who have also agreed to and comply with this License, including distributing copies of the Licensed Software to them, as part of exercising your rights under this License.
+
+### 2. Source Code
+This License also grants you the right to modify any portions of the Licensed Software provided by HYTOPIA in source code form (the "Licensed Source") and to use these modified versions for the Purpose.
+
+### 3. Usage Guidelines
+You must not use the Licensed Software to:
+
+- Transmit unlawful or objectionable material.
+- Transmit viruses or other harmful computer code.
+- Interfere with the performance of the Service or the data it contains.
+- Attempt to gain unauthorized access to the Service or related networks.
+- Interfere with another person's use of the Service.
+- Access or use the Licensed Software or the Service in connection with any alternative or competitive service.
+- Use the Licensed Software or the Service to reproduce, emulate, or replace features of the Service.
+- Remove any attribution information or proprietary notices in the Licensed Software.
+
+The Licensed Software may use, reference, or rely on materials separately available from HYTOPIA or other sources. Additional terms and conditions may apply to access and use any such dependencies.
+
+### 4. Feedback
+You may choose, but are not required, to provide HYTOPIA with feedback regarding the Licensed Software. This includes:
+
+- Reporting errors you encounter.
+- Providing suggestions for modifications and enhancements.
+- Submitting bug fixes, contributions, or other associated code.
+- Making other similar submissions (collectively, "Feedback").
+
+You retain ownership of your rights in any Feedback you provide. However, by submitting or making Feedback available to HYTOPIA, you irrevocably grant HYTOPIA and its successors an unrestricted, unlimited, worldwide, non-exclusive, transferable, sublicensable, fully paid-up, royalty-free license to:
+- Reproduce, distribute, publicly perform or display, and prepare derivative works of the Feedback.
+- Make, have made, use, sell, offer for sale, and import any product or service.
+- Practice any method disclosed in the Feedback.
+
+This license is granted in any form or manner and without limitation, attribution, or compensation.
+
+### 5. Reservation of Rights
+HYTOPIA retains all rights, title, and interest—including all intellectual property rights—in and to the Licensed Software and any derivatives thereof. Nothing in this License grants or confers on you any ownership of these rights, whether expressly, by implication, estoppel, or otherwise.
+
+### 6. Disclaimer; Limitation of Liability
+THE LICENSED SOFTWARE IS PROVIDED "AS IS" AND WITH ALL FAULTS. To the maximum extent permitted by applicable law, HYTOPIA disclaims all warranties, whether express, implied, statutory, or otherwise. This includes, without limitation, any warranties of merchantability, non-infringement, fitness for a particular purpose, or that the Licensed Software will be error-free or uninterrupted.
+
+In no event will HYTOPIA have any direct or indirect liability to you under this License. This includes any lost profits, loss of data, loss of use, costs of procuring substitute goods or services, or any special, punitive, or exemplary damages—however caused and under any theory of liability—whether in contract, tort, or otherwise, even if HYTOPIA has been advised of the possibility of such damages.
+
+You acknowledge and understand that the Licensed Software may be provided on an alpha, beta, or other pre-release basis. HYTOPIA is under no obligation to make any further releases, including any production release. Any subsequent release may differ from the Licensed Software in any manner HYTOPIA sees fit, including adding, modifying, or removing features and functionality present in the Licensed Software.
+
+You agree that the limitations of liability and disclaimers of warranties and damages set forth herein form an essential basis of your agreement with HYTOPIA. They will survive and apply even if found to have failed of their essential purpose, to the fullest extent permissible under applicable law.
+
+### 7. Term and Termination
+This Agreement begins on the date you accept this License and, unless terminated earlier as described below or extended by mutual written agreement, will terminate upon the later of:
+
+(a) The License Term specified when you access the Licensed Software, or
+(b) The public release of the production version of the Licensed Software (the "License Term").
+HYTOPIA may terminate this License (and your access to the Licensed Software and any associated materials) at any time, for any reason or no reason.
+
+Any provisions that by their nature or express terms survive expiration or termination of this License will survive such expiration or termination. Your obligations regarding Confidential Information and Feedback will survive indefinitely, regardless of any eventual publication of a commercial or production version of the Licensed Software.
+
+Upon expiration or termination of this License for any reason, you must cease using the Licensed Software and return or destroy all copies of the Licensed Software or Licensed Source (and any derivatives thereof) and any other Confidential Information in your possession.

package/README.md

@@ -0,0 +1,49 @@
+# HYTOPIA SDK
+
+## Quickstart
+
+1. Install the SDK in a new or existing [Node.js](https://nodejs.org/), [Bun (recommended)](https://bun.sh/) or [Deno](https://deno.com/) project.
+```bash
+npm install hytopia
+```
+
+2. Run a local HYTOPIA server using an example game included in the SDK. The following command will start the Zombie Arena example game on port 8080.
+```bash
+npx hytopia examples/zombie-arena
+```
+
+3. Visit https://play.hytopia.com - when prompted, enter the local server your game is running on, which is `http://localhost:8080`.
+
+## What is HYTOPIA?
+
+![HYTOPIA Banner](./docs/assets/banner.png)
+HYTOPIA is a modern games platform inspired by Minecraft, Roblox, and Rec Room.
+
+HYTOPIA allows you to create your own highly-sharable, immersive, massively multiplayer games in a voxel-like style. All playable in a web browser on any device!
+
+## What is this SDK?
+
+The HYTOPIA SDK makes it easy for developers to create multiplayer games on the HYTOPIA platform using JavaScript or TypeScript. 
+
+Available as a simple NPM package, this SDK provides everything you need to get started:
+
+- Compiled HYTOPIA Server: The ready-to-use server software.
+- Game Client & Debugger: For rapidly testing and developing your games.
+- TypeScript Definitions: For strong typing and code completion.
+- Documentation: Detailed guides and references.
+- Default Assets: Textures, models and audio you can use in your games.
+- Game Examples: Sample projects & scripts showing how to build different types of games.
+
+With these resources, you can quickly build and share immersive, voxel-style multiplayer games on HYTOPIA.
+
+## Architecture & Motivation
+
+HYTOPIA gives developers full control to create any game imaginable in a voxel-like style. The underlying architecture handles low-level tasks like networking, prediction, entity lifecycle, physics and more, so you can focus on building and deploying games quickly.
+
+With HYTOPIA's 100% server-authoritative setup and overall implementation, games are default-deterministic. All game inputs by players are relayed to and verified by the server, making gameplay naturally anti-cheat and preventing exploits like position spoofing.
+
+HYTOPIA overcomes the creativity limits of Minecraft, the complexities of Unity and UE5, and the difficult developer learning curve of Roblox with a developer-first, flexible approach, enabling you to build games in hours using JavaScript or TypeScript.
+
+Bring your own game assets as GLTF models with full server-driven animation support, block textures, ambient and sfx audio, and more - or use HYTOPIA's defaults included with this SDK to craft your game.
+
+We built HYTOPIA to empower both veteran and aspiring game developers to create multiplayer-first, voxel-style, hyper-sharable games. Developer APIs and documentations are simple, powerful and clear. Whether you've been building games for years, a frontend web developer who's dreamed of building a game, an eager learner that's always dreamed of building games, or a curious school student, HYTOPIA was built for you..