Download the PHP package aternos/modrinth-api without Composer
On this page you can find all versions of the php package aternos/modrinth-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package modrinth-api
Aternos/php-modrinth-api
An API client for the Modrinth API written in PHP. This client is a combination of code generated by OpenAPI Generator and some wrappers around it to improve the usability.
The generated code can be found in lib/Api and lib/Model. It is recommended
to use the Wrappers in lib/Client instead of the generated code.
Installation
Install the package via composer:
Usage
The main entry point for the API is the ModrinthAPIClient class.
The API Token is only required for non-public requests but if it is provided, it will be used for all requests.
Paginated Lists
Some methods return a paginated list which contains a list of results on the current page and methods to
navigate to the next and previous page. The paginated list implements Iterator, ArrayAccess and Countable so
you can use it like an array. It also has a getResults() method which returns the underlying array of results.
Searching for Projects
Search for Projects with Options
You can apply filters and change the sort order when searching for projects. All options are optional and can be combined.
Facets
One way to filter search results are facets. Facets specify which loader, category, game version or license to filter for. You need to provide exactly one AND group which can consist of multiple OR groups:
By default facets are checked using the equals operator. There are several other operators available:
Getting Additional Project Data
The Project wrapper provides methods to fetch additional data about the project.
Fetching Projects
You can also fetch individual projects by their id or slug:
or multiple projects by their ids:
It seems like fetching by slugs is also supported here but this is not documented.
Check if a slug/id is used
Project Dependencies
Get dependencies of a project
Versions
Hashes
The modrinth API also allows you to find a version by its SHA1 or SHA512 hash:
Users
Teams
Tags
You can fetch all available categories, loaders, game versions and licenses from the API. Our library provides methods to search projects by these directly:
You can also fetch donation platforms and report types:
Updating the generated code
The generated code can be updated by installing the openapi generator running the following command:
All versions of modrinth-api with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^7.3
guzzlehttp/psr7 Version ^1.7 || ^2.0