@mafiahub/types 0.1.11 → 0.1.13

package/LICENSE.txt

@@ -0,0 +1,86 @@
+MafiaHub source-available license
+Copyright (c) 2021 MafiaHub. All rights reserved.
+
+This license applies to MafiaHub Framework. The original work is maintained at
+https://github.com/MafiaHub/Framework.
+
+In this version, source-file headers naming the "MafiaHub OSS license" refer to the terms in this file.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
+following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
+disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following
+disclaimer in the documentation and/or other materials provided with the distribution.
+3. All advertising materials mentioning features or use of this software must display the following acknowledgement:
+This product includes software developed by MafiaHub.
+4. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products
+derived from this software without specific prior written permission.
+5. Except as permitted by clause 8, source code may be copied, forked, studied, modified and built only with the intent
+to contribute to the original work.
+Forks and development builds may be used and shared only for developing, reviewing and testing contributions intended
+for the original repository. This permission does not allow their use to operate a separate multiplayer platform or to
+provide a client or server for a public or private community.
+Outside this contribution work, using the Framework to develop or release another project requires specific prior
+written permission from MafiaHub.
+6. For projects using the Framework with MafiaHub's written permission, playing and hosting community servers is
+permitted using unmodified official client and server releases, subject to the project's license. Official releases
+are binaries published by MafiaHub or by maintainers authorized by MafiaHub.
+Outside contribution work permitted under clause 5, clients and servers must use those official releases. This
+restriction also applies to binaries built from unmodified source. A released Framework SDK does not grant permission
+to release or deploy a separate client, server or multiplayer platform.
+7. Building, distributing or operating a custom or alternative launcher for a project using the Framework is not
+permitted without specific prior written permission from MafiaHub. Changes to the official Framework launcher are
+permitted only for contribution development, review and testing under clause 5, and may not be deployed as a separate
+launcher for a community or platform.
+8. The scripting API declarations and example resources may be used, modified and redistributed to develop and run
+scripts, game modes and resources with official client and server releases permitted under clause 6. This permission
+does not extend to modified or source-built clients and servers or custom launchers. Conditions 1 through 4 continue
+to apply to copies and modifications of the declarations and example resources.
+
+Any use outside these permissions requires specific prior written permission from MafiaHub. Uses covered by specific
+written permission from MafiaHub remain allowed according to its terms, including permissions previously granted.
+A project license published by MafiaHub may provide that permission, including permission to contribute to that
+project's repository.
+
+Third-party components remain subject to their own licenses; this license does not replace or restrict the rights
+granted by those licenses. See the notices accompanying those components.
+
+THIS SOFTWARE IS PROVIDED BY COPYRIGHT HOLDER "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
+TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL
+COPYRIGHT HOLDER BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
+INTERRUPTION) HOWEVER 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 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
+DAMAGE.
+
+This codebase also depends on the following third-party libraries:
+    jitasm          - https://github.com/hlide/jitasm/blob/master/LICENSE
+    minhook         - https://github.com/TsudaKageyu/minhook/blob/master/LICENSE.txt
+    minhook helpers - https://github.com/citizenfx/fivem/blob/master/code/LICENSE
+    zpl.test        - https://github.com/zpl-c/zpl.test/blob/master/LICENSE
+    cppfs           - https://github.com/cginternals/cppfs/blob/master/LICENSE
+    cef             - https://github.com/chromiumembedded/cef/blob/master/LICENSE.txt
+    glm             - https://github.com/g-truc/glm/blob/master/copying.txt
+    discord         - https://discord.com/developers/docs/legal
+    httplib         - https://github.com/yhirose/cpp-httplib/blob/master/LICENSE
+    nlohmann-json   - https://github.com/nlohmann/json/blob/develop/LICENSE.MIT
+    nodejs          - https://github.com/nodejs/node/blob/master/LICENSE
+    openssl         - https://www.openssl.org/source/license.html
+    slikenet        - https://github.com/SLikeSoft/SLikeNet/blob/master/license.txt
+    optick          - https://github.com/bombomby/optick/blob/master/LICENSE
+    spdlog          - https://github.com/gabime/spdlog/blob/v1.x/LICENSE
+    steamworks      - https://partner.steamgames.com/documentation/sdk_access_agreement
+    sentry          - https://sentry.io/terms/
+    protobuf        - https://github.com/protocolbuffers/protobuf/blob/master/LICENSE
+    curl            - https://curl.se/docs/copyright.html
+    udis86          - https://github.com/vmt/udis86
+    cef             - https://bitbucket.org/chromiumembedded/cef/
+    fmt             - https://fmt.dev/latest/index.html
+    cxxopts         - https://github.com/jarro2783/cxxopts
+    libsig          - https://github.com/recp/libsig
+    sfd             - https://github.com/rxi/sfd
+    sdl2            - https://www.libsdl.org/license.php
+    stackwalker     - https://github.com/JochenKalmbach/StackWalker/blob/master/LICENSE
+    v8pp            - https://github.com/pmed/v8pp

package/framework/key.d.ts

@@ -16,6 +16,9 @@
  *   `insert` `delete` `home` `end` `pageup` `pagedown` `capslock`
  * - Numpad `numpad0`–`numpad9` (aliases `num0`–`num9`)
  * - Mouse `mouse1` (left) `mouse2` (right) `mouse3` (middle) `mouse4` `mouse5`
+ * - Wheel `wheelup` `wheeldown`: each notch fires `"down"` then `"up"`, and
+ *   the game still receives it. Never held, so `isDown` is always `false`.
+ *   Needs a game input adapter that reports the wheel (the framework's does).
  *
  * Letters and digits identify physical positions on a US keyboard. Use
  * `getLabel` to show the corresponding label in the player's current layout.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@mafiahub/types",
-    "version": "0.1.11",
+    "version": "0.1.13",
     "description": "TypeScript type definitions for the MafiaHub Framework scripting API",
     "types": "index.d.ts",
     "files": [
@@ -13,7 +13,10 @@
         "url": "git+https://github.com/MafiaHub/Framework.git",
         "directory": "types"
     },
-    "license": "SEE LICENSE IN ../LICENSE",
+    "license": "SEE LICENSE IN LICENSE.txt",
+    "scripts": {
+        "prepack": "node -e \"require('node:fs').copyFileSync('../LICENSE.txt', 'LICENSE.txt')\""
+    },
     "publishConfig": {
         "access": "public"
     }