mirror of
https://github.com/CommunityOx/ox_lib.git
synced 2026-08-16 22:46:03 +01:00
chore: update organization name
This commit is contained in:
@@ -6,7 +6,7 @@ We welcome you to contribute to our projects, whether reporting a bug, suggestin
|
|||||||
|
|
||||||
### Search for existing issues
|
### Search for existing issues
|
||||||
|
|
||||||
Before creating a new issue, please search existing [issues](https://github.com/overextended/ox_lib/issues) to see if it has already been reported.
|
Before creating a new issue, please search existing [issues](https://github.com/communityox/ox_lib/issues) to see if it has already been reported.
|
||||||
|
|
||||||
### Add details to existing issues
|
### Add details to existing issues
|
||||||
|
|
||||||
@@ -51,7 +51,7 @@ Pull requests that do not contribute meaningful improvements to the project's st
|
|||||||
- Fork the repository and, optionally, create a new branch for your changes.
|
- Fork the repository and, optionally, create a new branch for your changes.
|
||||||
- If applicable, include example code to demonstrate your changes.
|
- If applicable, include example code to demonstrate your changes.
|
||||||
- Ensure your code's style is consistent with the project, e.g. uses the same indentation and string quotations.
|
- Ensure your code's style is consistent with the project, e.g. uses the same indentation and string quotations.
|
||||||
- If you have modified or introduced new APIs, open a pull request to our [documentation](https://github.com/overextended/overextended.github.io). We will not accept undocumented code.
|
- If you have modified or introduced new APIs, open a pull request to our [documentation](https://github.com/communityox/docs). We will not accept undocumented code.
|
||||||
|
|
||||||
## Contributor License Agreement
|
## Contributor License Agreement
|
||||||
|
|
||||||
|
|||||||
16
README.md
16
README.md
@@ -2,10 +2,10 @@
|
|||||||
|
|
||||||
A FiveM library and resource implementing reusable modules, methods, and UI elements.
|
A FiveM library and resource implementing reusable modules, methods, and UI elements.
|
||||||
|
|
||||||

|

|
||||||

|

|
||||||

|

|
||||||

|

|
||||||
|
|
||||||
For guidelines to contributing to the project, and to see our Contributor License Agreement, see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
For guidelines to contributing to the project, and to see our Contributor License Agreement, see [CONTRIBUTING.md](./CONTRIBUTING.md)
|
||||||
|
|
||||||
@@ -14,19 +14,19 @@ For additional legal notices, refer to [NOTICE.md](./NOTICE.md).
|
|||||||
|
|
||||||
## 📚 Documentation
|
## 📚 Documentation
|
||||||
|
|
||||||
https://overextended.dev/ox_lib
|
https://coxdocs.dev/ox_lib
|
||||||
|
|
||||||
## 💾 Download
|
## 💾 Download
|
||||||
|
|
||||||
https://github.com/overextended/ox_lib/releases/latest/download/ox_lib.zip
|
https://github.com/communityox/ox_lib/releases/latest/download/ox_lib.zip
|
||||||
|
|
||||||
## 📦 npm package
|
## 📦 npm package
|
||||||
|
|
||||||
https://www.npmjs.com/package/@overextended/ox_lib
|
https://www.npmjs.com/package/@communityox/ox_lib
|
||||||
|
|
||||||
## 🖥️ Lua Language Server
|
## 🖥️ Lua Language Server
|
||||||
|
|
||||||
- Install [Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) to ease development with annotations, type checking, diagnostics, and more.
|
- Install [Lua Language Server](https://marketplace.visualstudio.com/items?itemName=sumneko.lua) to ease development with annotations, type checking, diagnostics, and more.
|
||||||
- Install [cfxlua-vscode](https://marketplace.visualstudio.com/items?itemName=overextended.cfxlua-vscode) to add natives and cfxlua runtime declarations to LLS.
|
- Install [cfxlua-vscode](https://marketplace.visualstudio.com/items?itemName=communityox.cfxlua-vscode) to add natives and cfxlua runtime declarations to LLS.
|
||||||
- You can load ox_lib into your global development environment by modifying workspace/user settings "Lua.workspace.library" with the resource path.
|
- You can load ox_lib into your global development environment by modifying workspace/user settings "Lua.workspace.library" with the resource path.
|
||||||
- e.g. "c:/fxserver/resources/ox_lib"
|
- e.g. "c:/fxserver/resources/ox_lib"
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ name 'ox_lib'
|
|||||||
author 'Overextended'
|
author 'Overextended'
|
||||||
version '3.30.6'
|
version '3.30.6'
|
||||||
license 'LGPL-3.0-or-later'
|
license 'LGPL-3.0-or-later'
|
||||||
repository 'https://github.com/overextended/ox_lib'
|
repository 'https://github.com/communityox/ox_lib'
|
||||||
description 'A library of shared functions to utilise in other resources.'
|
description 'A library of shared functions to utilise in other resources.'
|
||||||
|
|
||||||
dependencies {
|
dependencies {
|
||||||
|
|||||||
@@ -59,7 +59,7 @@ end
|
|||||||
|
|
||||||
local table = lib.table
|
local table = lib.table
|
||||||
|
|
||||||
---Loads the ox_lib locale module. Prefer using fxmanifest instead (see [docs](https://overextended.dev/ox_lib#usage)).
|
---Loads the ox_lib locale module. Prefer using fxmanifest instead (see [docs](https://coxdocs.dev/ox_lib#usage)).
|
||||||
---@param key? string
|
---@param key? string
|
||||||
function lib.locale(key)
|
function lib.locale(key)
|
||||||
local lang = key or lib.getLocaleKey()
|
local lang = key or lib.getLocaleKey()
|
||||||
|
|||||||
@@ -9,13 +9,13 @@ You still need to use and have the ox_lib resource included into the resource yo
|
|||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
# With pnpm
|
# With pnpm
|
||||||
pnpm add @overextended/ox_lib
|
pnpm add @communityox/ox_lib
|
||||||
|
|
||||||
# With Yarn
|
# With Yarn
|
||||||
yarn add @overextended/ox_lib
|
yarn add @communityox/ox_lib
|
||||||
|
|
||||||
# With npm
|
# With npm
|
||||||
npm install @overextended/ox_lib
|
npm install @communityox/ox_lib
|
||||||
```
|
```
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
@@ -23,16 +23,16 @@ You can either import the lib from client or server files or deconstruct the obj
|
|||||||
you may require.
|
you may require.
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import lib from '@overextended/ox_lib/client'
|
import lib from '@communityox/ox_lib/client'
|
||||||
```
|
```
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import lib from '@overextended/ox_lib/server'
|
import lib from '@communityox/ox_lib/server'
|
||||||
```
|
```
|
||||||
|
|
||||||
```ts
|
```ts
|
||||||
import { checkDependency } from '@overextended/ox_lib/shared';
|
import { checkDependency } from '@communityox/ox_lib/shared';
|
||||||
```
|
```
|
||||||
|
|
||||||
## Documentation
|
## Documentation
|
||||||
[View documentation](https://overextended.github.io/docs/ox_lib)
|
[View documentation](https://coxdocs.dev/ox_lib)
|
||||||
@@ -1,5 +1,5 @@
|
|||||||
{
|
{
|
||||||
"name": "@overextended/ox_lib",
|
"name": "@communityox/ox_lib",
|
||||||
"author": "Overextended",
|
"author": "Overextended",
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"description": "JS/TS wrapper for ox_lib exports",
|
"description": "JS/TS wrapper for ox_lib exports",
|
||||||
@@ -14,14 +14,15 @@
|
|||||||
"fivem",
|
"fivem",
|
||||||
"ox_lib",
|
"ox_lib",
|
||||||
"ox",
|
"ox",
|
||||||
"overextended"
|
"overextended",
|
||||||
|
"communityox"
|
||||||
],
|
],
|
||||||
"repository": {
|
"repository": {
|
||||||
"type": "git",
|
"type": "git",
|
||||||
"url": "git+https://github.com/overextended/ox_lib.git"
|
"url": "git+https://github.com/communityox/ox_lib.git"
|
||||||
},
|
},
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://github.com/overextended/ox_lib/issues"
|
"url": "https://github.com/communityox/ox_lib/issues"
|
||||||
},
|
},
|
||||||
"license": "LGPL-3.0",
|
"license": "LGPL-3.0",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
|
|||||||
@@ -44,7 +44,7 @@ cache = {
|
|||||||
|
|
||||||
if not LoadResourceFile(lib.name, 'web/build/index.html') then
|
if not LoadResourceFile(lib.name, 'web/build/index.html') then
|
||||||
local err =
|
local err =
|
||||||
'^1Unable to load UI. Build ox_lib or download the latest release.\n ^3https://github.com/overextended/ox_lib/releases/latest/download/ox_lib.zip^0'
|
'^1Unable to load UI. Build ox_lib or download the latest release.\n ^3https://github.com/communityox/ox_lib/releases/latest/download/ox_lib.zip^0'
|
||||||
function lib.hasLoaded() return err end
|
function lib.hasLoaded() return err end
|
||||||
|
|
||||||
error(err)
|
error(err)
|
||||||
|
|||||||
@@ -43,4 +43,4 @@ function lib.versionCheck(repository)
|
|||||||
end)
|
end)
|
||||||
end
|
end
|
||||||
|
|
||||||
lib.versionCheck('overextended/ox_lib')
|
lib.versionCheck('communityox/ox_lib')
|
||||||
|
|||||||
Reference in New Issue
Block a user