{"id":13469832,"url":"https://github.com/Lodestone-Team/lodestone_core","last_synced_at":"2025-03-26T09:31:23.848Z","repository":{"id":38286436,"uuid":"478258995","full_name":"Lodestone-Team/lodestone_core","owner":"Lodestone-Team","description":"The backend for Lodestone, A free, open source server hosting tool for Minecraft and other multiplayers","archived":false,"fork":false,"pushed_at":"2024-06-21T02:10:17.000Z","size":12157,"stargazers_count":59,"open_issues_count":32,"forks_count":7,"subscribers_count":2,"default_branch":"main","last_synced_at":"2024-07-11T23:18:58.325Z","etag":null,"topics":["axum","backend","minecraft","minecraft-server-wrapper","rust"],"latest_commit_sha":null,"homepage":"https://www.lodestone.cc/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Lodestone-Team.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.MD","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-05T18:47:21.000Z","updated_at":"2024-06-15T18:08:18.000Z","dependencies_parsed_at":"2024-06-18T00:54:24.394Z","dependency_job_id":null,"html_url":"https://github.com/Lodestone-Team/lodestone_core","commit_stats":null,"previous_names":[],"tags_count":12,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lodestone-Team%2Flodestone_core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lodestone-Team%2Flodestone_core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lodestone-Team%2Flodestone_core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Lodestone-Team%2Flodestone_core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Lodestone-Team","download_url":"https://codeload.github.com/Lodestone-Team/lodestone_core/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":213380547,"owners_count":15578385,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["axum","backend","minecraft","minecraft-server-wrapper","rust"],"created_at":"2024-07-31T16:00:17.312Z","updated_at":"2024-07-31T16:01:16.547Z","avatar_url":"https://github.com/Lodestone-Team.png","language":"Rust","funding_links":[],"categories":["Apps"],"sub_categories":["Gaming"],"readme":"\n\u003cdiv id=\"top\"\u003e\u003c/div\u003e\n\u003c!--\n*** Thanks for checking out the Best-README-Template. If you have a suggestion\n*** that would make this better, please fork the repo and create a pull request\n*** or simply open an issue with the tag \"enhancement\".\n*** Don't forget to give the project a star!\n*** Thanks again! Now go create something AMAZING! :D\n--\u003e\n\n\n\n\u003c!-- PROJECT SHIELDS --\u003e\n\u003c!--\n*** I'm using markdown \"reference style\" links for readability.\n*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).\n*** See the bottom of this document for the declaration of the reference variables\n*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.\n*** https://www.markdownguide.org/basic-syntax/#reference-style-links\n--\u003e\n[![Contributors][contributors-shield]][contributors-url]\n[![Issues][issues-shield]][issues-url]\n[![Build][workflow-shield]][workflow-url]\n\u003c!-- [![Forks][forks-shield]][forks-url]\n[![Stargazers][stars-shield]][stars-url] --\u003e\n\u003c!-- [![MIT License][license-shield]][license-url] --\u003e\n\u003c!-- [![LinkedIn][linkedin-shield]][linkedin-url] --\u003e\n\n\n\n\u003c!-- PROJECT LOGO --\u003e\n\u003cbr /\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/Lodestone-Team/client\"\u003e\n    \u003cimg src=\"readme/lodestone_logo.svg\" alt=\"Logo\" width=\"80\" height=\"80\"\u003e\n  \u003c/a\u003e\n\n\u003ch3 align=\"center\"\u003eLodestone\u003c/h3\u003e\n  \u003cp align=\"center\"\u003e\n    Client for the Lodestone project\n    \u003cbr /\u003e\n    \u003ca href=\"https://beta.lodestone.cc/\"\u003e\u003cstrong\u003eWebsite(Beta WIP) »\u003c/strong\u003e\u003c/a\u003e\n    \u003cbr /\u003e\n    \u003cbr /\u003e\n    \u003c!-- \u003ca href=\"https://github.com/github_username/repo_name\"\u003eView Demo\u003c/a\u003e --\u003e\n    ·\n    \u003ca href=\"https://github.com/Lodestone-Team/client/issues\"\u003eReport Bug\u003c/a\u003e\n    ·\n    \u003ca href=\"https://github.com/Lodestone-Team/client/issues\"\u003eRequest Feature\u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n\n\n\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n\n\n### !!Repo Deprecated!!\n\nThis repo is functionally deprecated in favour of the new mono repo: https://github.com/Lodestone-Team/lodestone\n\nHowever, due to Lodestone CLI still pointing to this repo to fetch the latest releases, this repo is not archived.\n\n\n### Built With\n\n\n* [![Rust][Rust]][Rust-url]\n\u003c!-- * [![Node.js][Node.js]][Node.js-url] --\u003e\n\u003c!-- * [![Express][Express]][Express-url] --\u003e\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n## Getting Started (end user)\n\nYou should not download Lodestone Core directly due to its lack of ability to self-update. Please use [Lodestone CLI](https://github.com/Lodestone-Team/lodestone_cli) instead.\n\n### Using Docker Image\n\nAs of v0.4.3 we have added Docker support to lodestone core.\nOur precompiled images will be based on the newest release available from: `ghcr.io/lodestone-team/lodestone_core`.\nAlternatively, you may build your own image using the default `Dockerfile`, not additional arguments required.\n\n\u003e **Note**\n\u003e You may add additional ports as you wish to forward, but 16662 is the default port served in the image.\n\u003e You may add a volume for your lodestone instance to be accessible, in the example below, you can create a volume first by using `docker volume create lodestone`.\n\nDocker CLI example:\n```sh\ndocker run -d \\\n  --name lodestone \\\n  --restart unless-stopped \\\n  -p 16662:16662 \\\n  -v lodestone:/home/user/.lodestone \\\n  ghcr.io/lodestone-team/lodestone_core\n```\nDocker Compose example:\n\nDownload the docker-compose.yml file from this repo using\n```sh\nwget https://raw.githubusercontent.com/Lodestone-Team/lodestone_core/main/docker-compose.yml\n```\nand then run it using\n```sh\ndocker compose up -d\n```\nAlternatively, create docker-compose.yml yourself:\n```yml\nversion: '3.8'\nservices:\n  lodestone:\n    container_name: lodestone\n    image: ghcr.io/lodestone-team/lodestone_core\n    restart: unless-stopped\n    ports:\n      - \"16662:16662\"\n    volumes:\n      - lodestone:/home/user/.lodestone\n\nvolumes:\n  lodestone:\n```\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started (development)\n\nPlease make sure you have `cargo` and `rustc`, for instruction on how to install the Rust toolchain, see here: [rustup.rs](https://rustup.rs/).\n\n### Prerequisites\n\nThese instructions apply to Ubuntu 20.04 LTS and later.\n\n* `build-essential` is required for the Rust toolchain.\n  ```sh\n  sudo apt-get install build-essential\n  ```\n* `pkg-config` and `libssl-dev` are required to compile Axum\n  ```sh\n  sudo apt-get install pkg-config libssl-dev\n  ```\n* `cpuidtool` is required to query CPU information\n  ```sh\n  sudo apt-get install cpuidtool libcpuid-dev\n  ```\n  A few other packages are needed to compile Lodestone\n  ```sh\n  sudo apt-get install libffi-dev libmagic-dev file\n  ```\n\n### Installation\n#### Running the client\n\n1. Clone the repo\n   ```sh\n   git clone https://github.com/Lodestone-Team/client\n   ```\n2. By default Lodestone stores its data in `~/.lodestone`. If you would like to override it for development \u0026 testing please define the `LODESTONE_PATH` environment variable to override it.\n   ```sh\n   export LODESTONE_PATH=~/test_dev\n   ```\n3. Running\n   ```sh\n   cargo run --bin main\n   ```\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- USAGE EXAMPLES --\u003e\n\u003c!-- ## Usage\n\nFollow the instruction on our [Github page](https://github.com/Lodestone-Team#installation)\n\n_For more examples, please refer to the [Documentation](https://example.com)_\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e --\u003e\n\n\n\n\u003c!-- ROADMAP --\u003e\n\u003c!-- ## Roadmap\n\n- [ ] Feature 1\n- [ ] Feature 2\n- [ ] Feature 3\n    - [ ] Nested Feature\n\nSee the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e --\u003e\n\n\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContribution is welcome, please join our [Discord](https://discord.gg/yKrSZXbhNx) for more details.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- LICENSE --\u003e\n## License\n\nThis project uses the GNU Affero General Public License v3.0. See our LICENSE files for details. For an alternate (commercial) license, please raise an issue.\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- CONTACT --\u003e\n\u003c!-- ## Contact\n\nYour Name - [@twitter_handle](https://twitter.com/twitter_handle) - email@email_client.com\n\nProject Link: [https://github.com/github_username/repo_name](https://github.com/github_username/repo_name)\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e --\u003e\n\n\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n## Credits\n\nActive members of the Lodestone client team:\n\n* [Peter Jiang (CheatCod)](https://github.com/CheatCod) - Lead Developer\n* [Kevin Huang (Ynng)](https://github.com/Ynng) - Developer\n* [Mark Sun (Lemonsity)](https://github.com/Lemonsity) - Developer\n\n\u003cp align=\"right\"\u003e(\u003ca href=\"#top\"\u003eback to top\u003c/a\u003e)\u003c/p\u003e\n\n\n\n\u003c!-- MARKDOWN LINKS \u0026 IMAGES --\u003e\n\u003c!-- https://www.markdownguide.org/basic-syntax/#reference-style-links --\u003e\n[contributors-shield]: https://img.shields.io/github/contributors/Lodestone-Team/client?style=for-the-badge\n[contributors-url]: https://github.com/Lodestone-Team/client/graphs/contributors\n\u003c!-- [forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge\n[forks-url]: https://github.com/github_username/repo_name/network/members\n[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge\n[stars-url]: https://github.com/github_username/repo_name/stargazers --\u003e\n[issues-shield]: https://img.shields.io/github/issues/Lodestone-Team/client?style=for-the-badge\n[issues-url]: https://github.com/Lodestone-Team/client/issues\n[workflow-shield]: https://img.shields.io/github/actions/workflow/status/Lodestone-Team/client/push.yml?style=for-the-badge\n[workflow-url]: https://github.com/Lodestone-Team/lodestone_core/actions\n[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge\n[license-url]: https://github.com/github_username/repo_name/blob/master/LICENSE.txt\n[product-screenshot]: images/screenshot.png\n[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge\u0026logo=react\u0026logoColor=61DAFB\n[React-url]: https://reactjs.org/\n[Rust]: https://img.shields.io/badge/RUST-000000?style=for-the-badge\u0026logo=RUST\u0026logoColor=white\n[Rust-url]: https://www.rust-lang.org/\n[TypeScript]: https://img.shields.io/badge/TypeScript-000000?style=for-the-badge\u0026logo=TypeScript\u0026logoColor=white\n[TypeScript-url]: https://www.typescriptlang.org/\n[Node.js]: https://img.shields.io/badge/Node.js-000000?style=for-the-badge\u0026logo=Node.js\u0026logoColor=white\n[Node.js-url]: https://nodejs.org/en/\n[Express.js]: https://img.shields.io/badge/Express.js-000000?style=for-the-badge\u0026logo=Express.js\u0026logoColor=white\n[Express.js-url]: https://expressjs.com/\n\u003c!-- [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge\u0026logo=linkedin\u0026colorB=555\n[linkedin-url]: https://linkedin.com/in/linkedin_username --\u003e\n\u003c!-- [Next.js]: https://img.shields.io/badge/next.js-000000?style=for-the-badge\u0026logo=nextdotjs\u0026logoColor=white\n[Next-url]: https://nextjs.org/ --\u003e\n\u003c!-- [Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge\u0026logo=vuedotjs\u0026logoColor=4FC08D\n[Vue-url]: https://vuejs.org/\n[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge\u0026logo=angular\u0026logoColor=white\n[Angular-url]: https://angular.io/\n[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge\u0026logo=svelte\u0026logoColor=FF3E00\n[Svelte-url]: https://svelte.dev/\n[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge\u0026logo=laravel\u0026logoColor=white\n[Laravel-url]: https://laravel.com\n[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge\u0026logo=bootstrap\u0026logoColor=white\n[Bootstrap-url]: https://getbootstrap.com\n[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge\u0026logo=jquery\u0026logoColor=white\n[JQuery-url]: https://jquery.com  --\u003e\n\n\u003c!-- [Trello](https://trello.com/b/sCaSEPyU/lodestone)\n[Figma](https://www.figma.com/file/gM7KUynANg4JkGF3QBsYJ9/Lodestone?node-id=166%3A1621) --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLodestone-Team%2Flodestone_core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FLodestone-Team%2Flodestone_core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FLodestone-Team%2Flodestone_core/lists"}