DOCSEARCHbyAlgolia
Submit Docs

HITMODS Documentation

website·Indexed 30 days ago

https://docs.hitmods.com

Documentation for the HITMODS platform and its RESTful API. Includes guides on mod review processes, team management and permissions, and API endpoints for retrieving and editing mods, teams, and users.

Tokens
947
Snippets
3
Records
15
Agent score
49%

What's inside HITMODS

  1. Understand the HITMODS mod review process

    All mods uploaded to the HITMODS platform undergo a review by site moderators and admins before becoming public. This process is designed to prevent spam, abuse, and malicious content. Reviews typically take one to two days, though simple mods may be processed faster and complex ones may take longer.

  2. Understand the Team entity in HitMods

    In HitMods, a Team is a collection of mods created by an individual or a group. To maintain system consistency and reduce complexity, every mod must belong to a team, regardless of whether the mod is developed by a single person or a large group.

  3. Delete your HITMODS account

    You can delete your account by navigating to the "Settings" page and clicking the "Delete Account" button. Note that deleting your account erases your personal data, but it will not delete any mods or teams associated with the account.

  4. Manage Team membership and permissions

    Teams provide a flexible way to organize mod development with the following capabilities:

    • Membership: Any user can create a team. New members can be invited to join via the team's 'people' page.
    • Permissions: Access control is flexible; permissions can be granted on a per-mod basis or applied team-wide.

  5. Delete a mod or team on HITMODS

    Users cannot delete mods or teams directly. To prevent accidental removal of quality content, you must open a support ticket to request the deletion of a mod or team.

  6. Handle mod rejections on HITMODS

    If a mod is rejected during the review process, the HITMODS team will provide the specific reasons for the rejection. Users are permitted to address the identified issues and re-submit the mod for another review.

  7. Retrieve a specific mod by team and mod slugs

    Use the GET /mods/:teamSlug/:modSlug endpoint to retrieve data for a specific mod. You must provide both the slug of the team the mod belongs to and the slug of the mod itself.
    GET /mods/:teamSlug/:modSlug

  8. Create a new Team in HITMODS

    All mods in HITMODS must belong to a team. You can create a new team by sending a POST request to the /teams endpoint.
    POST /teams

  9. Authenticate requests to the HITMODS API

    The HITMODS API is a RESTful service. While many requests do not require authentication, all privileged requests must be authenticated using a JSON Web Token (JWT). The JWT must be provided in the Authorization header as a Bearer token. Note that anonymous users may experience aggressive rate limits or receive a limited set of data from certain endpoints.
    Authorization: Bearer <your_jwt_token>

  11. Manage team membership and permissions with 'Manage People'

    The 'Manage People' permission is intended for trusted team administrators. It grants the following abilities:

    • Invite new members to the team.
    • Remove (kick) members from the team (excluding the owner).
    • Modify the permissions of other team members.

    Caution: Users with this permission can demote other members, including the person who granted the permission.

  12. Understand Team Owner permissions and transfer

    The Owner of a team is the individual who created the team and possesses all available permissions. Ownership cannot be transferred automatically through the platform; to transfer ownership, a support ticket must be created.