-
Notifications
You must be signed in to change notification settings - Fork 10
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Improve existing documentation. - Add some missing documentation. - Partially standardize code styling and other stuff. - Remove docs for heavily WIP resources (ambulancejob & medical).
- Loading branch information
Showing
65 changed files
with
2,270 additions
and
2,071 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,2 +1,3 @@ | ||
| .next | ||
| node_modules | ||
| out |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,9 +1,12 @@ | ||
| # Nextra Docs Template | ||
|
|
||
| This is a template for creating documentation with [Nextra](https://nextra.site). | ||
| # Qbox Project Documentation | ||
|
|
||
| ## Local Development | ||
|
|
||
| First, run `pnpm i` to install the dependencies. | ||
|
|
||
| Then, run `pnpm dev` to start the development server and visit localhost:3000. | ||
|
|
||
| ## Acknowledgements | ||
|
|
||
| - [`shuding/nextra-docs-template`](https://github.com/shuding/nextra-docs-template) - the template used | ||
| - [`overextended/overextended.github.io`](https://github.com/overextended/overextended.github.io) - much of the styling copied over from here |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| import '../style.css'; | ||
|
|
||
| export default function App({ Component, pageProps }) { | ||
| return <Component {...pageProps} />; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,44 @@ | ||
| # Frequently Asked Questions | ||
|
|
||
| ## What are the differences between Qb and Qbox? | ||
| ## What are the differences between QBCore and Qbox? | ||
|
|
||
| While originally forked from Qb, many Qbox resources have been refactored to improve code quality, enhance security, lower performance overhead, and integrate with [overextended](https://overextended.dev) resources. | ||
| Where appropriate Qbox also integrates directly with other open source projects, rather than maintain subpar resources in-house. | ||
| Qbox maintains high quality standards, with a strong community of regular contributors. As time goes on, expect greater differences in player facing features. | ||
| While originally forked from QBCore, many Qbox resources have been refactored to improve code quality, enhance security, lower performance overhead, and integrate with [overextended](https://overextended.dev) resources. | ||
| Where appropriate Qbox also integrates directly with other open source projects, rather than maintaining subpar resources in-house. | ||
|
|
||
| ## Will Qb compatible scripts work with Qbox? | ||
| Qbox maintains high quality standards, with a strong community of regular contributors. | ||
| As time goes on, expect greater differences in player facing features. | ||
|
|
||
| Yes. We've created a bridge layer for backwards compatibility with Qb scripts. You can continue to use Qb scripts without any modifications. | ||
| ## Will my QBCore scripts work with Qbox? | ||
|
|
||
| ## When will Qbox get a stable release? | ||
| TL;DR: Yes (in most cases). | ||
|
|
||
| Expect individual resources to get versioned releases over the coming months as they get stabilized and tested. | ||
| We've created a bridge layer for backwards compatibility with the documented and proper ways of using qb-core, | ||
| and you can continue to use most QBCore scripts without any modifications. | ||
|
|
||
| An exception to this is resources that use qb-core in undocumented, unsupported, invalid, and/or improper ways, such as: | ||
| - Direct access to database tables; | ||
| - Direct access to qb-core files that aren't meant to be used by other resources; | ||
| - Invalid usages of existing functions; | ||
| - And other unexpected ways not mentioned here. | ||
|
|
||
| ## Who should use Qbox? | ||
|
|
||
| Servers currently using QB and servers interested in running QB resources in the future | ||
| Servers currently using QBCore and servers interested in running QBCore in the future. | ||
|
|
||
| ## Is Qbox ready to use? | ||
|
|
||
| Since qbx_core is backwards compatible with qb-core resources, we recommend using only the released Qbox resources for a stable experience. | ||
|
|
||
| ## Is Qbox ready to be used? | ||
| Since qbx_core is backwards compatible with qb resources, we recommend using the released qbox resources only for a stable experience. | ||
| ## Which resources are ready to use? | ||
|
|
||
| ## Which resources are released? | ||
| - [qbx_core](./resources/qbx_core) | ||
| - [qbx_divegear](./resources/qbx_divegear) | ||
| - [qbx_diving](./resources/qbx_diving) | ||
| - [qbx_binoculars](./resources/qbx_binoculars) | ||
| - [qbx_management](./resources/qbx_management) | ||
|
|
||
| qbx_core | ||
| qbx_divegear | ||
| qbx_diving | ||
| qbx_binoculars | ||
| qbx_management | ||
| ## Common Problems | ||
|
|
||
| # Common Problems | ||
| ### No such export GetCoreObject in resource qbx_core | ||
|
|
||
| ## No Such export GetCoreObject in resource qbx_core | ||
| Qbox does not have the core object. However, you can continue to use exports['qb-core']:GetCoreObject() to get a core object from Qbox's QB bridge layer. | ||
| Qbox does not have the core object. However, you can continue to use `exports['qb-core']:GetCoreObject()` to get a core object from Qbox's QB bridge layer. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,35 @@ | ||
| import { Callout } from 'nextra/components' | ||
|
|
||
| # Introduction | ||
|
|
||
| Qbox is a FiveM roleplay framework. This framework strives to be greater and combines with [overextended's resources](https://github.com/overextended) to achieve this greatness. Come witness the greatness and be overwhelmed by it! | ||
| Qbox is a FiveM roleplay framework created on September 27, 2022. | ||
|
|
||
| <Callout> | ||
| Qbox was created on September 27, 2022. | ||
| This project started as a fork of QBCore with a goal of making improvements while maintaining backwards compatibility. | ||
| </Callout> | ||
| Starting as a QBCore fork, its goal was improving upon QBCore while maintaining backwards compatibility. \ | ||
| Today this framework strives to be much greater, and utilizes [overextended's resources](https://github.com/overextended) to achieve its goals. | ||
|
|
||
| ## Contributing | ||
| ## Support & Questions | ||
|
|
||
| Contributions are always welcome, but we prefer quality over quantity! Please read our [contributing guidelines](https://qbox-project.github.io/contributors) to learn how best to contribute. | ||
| Support for Qbox is provided by the community in the support channels of the [Qbox Discord](https://discord.gg/qbox). | ||
|
|
||
| Luckily, Qbox benefits from a great community with varied experience. | ||
| We encourage everyone to help each other in a friendly and respectable manner. | ||
|
|
||
| ## Support | ||
| ## Converting from QBCore | ||
|
|
||
| Support for Qbox is provided by the community in the support channels of the [Qbox Discord](https://discord.gg/qbox). | ||
| Already have a server that uses QBCore? No worries! | ||
| Qbox has backwards-compatibility for almost all QBCore scripts, with a few exceptions (learn more in the [FAQ](./faq#will-my-qbcore-scripts-work-with-qbox)). | ||
|
|
||
| Planning on converting to Qbox anyway to be able to utilize its new and modern functions and features? | ||
| Learn how to convert your resources to Qbox in [Converting from QBCore](./converting). | ||
|
|
||
| ## Note for Developers | ||
|
|
||
| Planning on utilizing qbx_core in your next resource? | ||
| Make sure to read the [Developer's Guide](./developers) to learn about principles that make you avoid bad practices and help you in having a better developer expetience. | ||
|
|
||
| ## Contributing to Qbox | ||
|
|
||
| Contributions are always welcome, but we prefer quality over quantity! | ||
| Please read our [contributing guidelines](https://qbox-project.github.io/contributors) to learn how best to contribute. | ||
|
|
||
| ## Frequently Asked Questions | ||
|
|
||
| Luckily, Qbox benefits from a great community with varied experience. We encourage everyone to help each other in a friendly and respectable manner. | ||
| Check out the [FAQ](./faq) to learn more about Qbox. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,43 +1,43 @@ | ||
| import { Callout, Steps, Tabs } from 'nextra/components' | ||
|
|
||
| # Installation | ||
| <Callout type="info" emoji="ℹ️"> | ||
| We highly recommend using **txAdmin** to install your FiveM server. | ||
| For detailed instructions, refer to [Setting up a server](https://docs.fivem.net/docs/server-manual/setting-up-a-server-txadmin/). | ||
|
|
||
| <Callout type="info"> | ||
| We highly recommend using **txAdmin** to install your FiveM server. \ | ||
| For detailed instructions, refer to [Setting up a server using txAdmin](https://docs.fivem.net/docs/server-manual/setting-up-a-server-txadmin/). | ||
| </Callout> | ||
|
|
||
| <Steps> | ||
| ### Download the server | ||
| 1. Download the latest [FiveM artifacts](https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/) and extract the files. | ||
| ### Download the server | ||
|
|
||
| Download the latest [FiveM artifacts](https://runtime.fivem.net/artifacts/fivem/build_server_windows/master/) and extract the files. | ||
|
|
||
| ### Start the server installation | ||
| Run `FXServer.exe` to begin the installation and follow all the steps. | ||
| ### Start the server installation | ||
|
|
||
| ### Deploy the recipe | ||
| When prompted, select `Remote URL Template` | ||
|
|
||
| Run `FXServer.exe` to begin the installation and follow all the steps. | ||
|
|
||
|  | ||
| ### Deploy the recipe | ||
|
|
||
| When prompted, select `Remote URL Template`: | ||
|
|
||
| Use the raw recipe link shown below. | ||
|  | ||
|
|
||
| <Tabs items={['QBox', 'Qbox Lean']} defaultIndex="0"> | ||
| <Tabs.Tab> | ||
| ```ansi filename="Qbox recipe" copy | ||
| https://raw.githubusercontent.com/Qbox-project/txAdminRecipe/main/qbox.yaml | ||
| ``` | ||
| </Tabs.Tab> | ||
| <Tabs.Tab> | ||
| ```ansi filename="Qbox Lean recipe" copy | ||
| https://raw.githubusercontent.com/Qbox-project/txAdminRecipe/main/qbox-lean.yaml | ||
| ``` | ||
| </Tabs.Tab> | ||
| </Tabs> | ||
| Use the raw recipe link shown below. | ||
|
|
||
| ### Run the server | ||
| <Tabs items={['Qbox', 'Qbox Lean']} defaultIndex="0"> | ||
| <Tabs.Tab> | ||
| ```ansi filename="Qbox recipe" copy | ||
| https://raw.githubusercontent.com/Qbox-project/txAdminRecipe/main/qbox.yaml | ||
| ``` | ||
| </Tabs.Tab> | ||
| <Tabs.Tab> | ||
| ```ansi filename="Qbox Lean recipe" copy | ||
| https://raw.githubusercontent.com/Qbox-project/txAdminRecipe/main/qbox-lean.yaml | ||
| ``` | ||
| </Tabs.Tab> | ||
| </Tabs> | ||
|
|
||
| Once you have completed all of the installation steps, run the server. | ||
| ### Run the server | ||
|
|
||
| </Steps> | ||
| Once you have completed all of the installation steps, run the server. | ||
| </Steps> |
Oops, something went wrong.