SANDBOX — this is a test environment. No servers are actually deployed and no real payments are charged.
Source-checkedQuality of life & UI

Achievements

by Nateonus · for Vintage Story

Adds achievements to Vintage Story! Create achievements in your own mods using JSON files or code!

11KDownloads
1.18.15Latest game version
Vintage Story ModDBSource

About Achievements

From Vintage Story ModDB

Adds achievements to Vintage Story! Create achievements in your own mods using JSON files or code!

You guessed it - This mod adds achievements. Currently comes with 16 achievements, and contains a super easy API for other modders to add achievements!

Achievements work on singleplayer and multiplayer! If used on a server, unlocking an achievement will be broadcast to all players, if the server's modconfig allows it.

Other mod developers should check out the Api Details section below. You can add achievements for this mod without requiring a dependency!

Press 'L' (configurable) to open your Achievements Journal.

If you wish to support my work, please consider donating a small amount at https://ko-fi.com/nateonus!

The achievements mod can be added to existing worlds without issue.

The following mods support achievements:

Mods with Achievements:

Want your mod listed here? Use the achievements mod API and leave a comment!

Mod Authors - Code Api Details!

The achievements API consists of a single .cs class that can be used to register, unlock, and check achievements.

The great thing about this is that it requires no dependencies on your part. If the user has the achievements mod installed and enabled, your newly added achievements will work. If the user does not have the achievements mod installed and enabled, your newly achievements will just silently not do anything. Error free, and easy to manage.

Step by step instructions:

  1. Create a new .cs class file, named "AchievementsManager".
  2. Replace your new file with the entire contents of the script below.
  3. Achievements should be registered on both sides - So call RegisterAchievement as many times as needed in your mod system's Start function.
  4. The achievementId should be unique across all mods - It is recommended to use something that is tied to your mod name to ensure it is unique, otherwise it will not be correctly registered.
  5. The achievementGraphicCode is a full item or block code. e.g. "gear-rusty" or "clay-fire".
  6. To finish setting up your achievement, add the following entries to your .lang file:
    1. "achievement-{achievementId}": "{Achievement name}"
    2. "achievement-{achievementId}-desc": "{Achievement description}"
    3. (Optional!) "achievement-{achievementId}-desc-undiscovered" : "{Achievement description when not unlocked}"
  7. Achievements can be unlocked or checked on either client side or server side.
    1. Achievements should not be checked before they are unlocked - The unlock function already does this. If the achievement has already been unlocked, nothing happens.
  8. The given script contains no error checking for an invalid achievement id. It is up to you to keep these ids in a static place.
  9. If your achievement appears in the Achievements Journal (L) (Requires Achievements mod installed), you have successfully created an achievement.
AchievementsManager.cs
<pre class="language-csharp">using System; using System.Collections.Generic; using System.Linq; using System.Reflection; using System.Text; using System.Threading.Tasks; using Vintagestory.API.Common;

namespace Achievements { internal class AchievementsManager { static Assembly cachedAchievementsAssembly = null; static MethodInfo registerAchievementMethod = null; static MethodInfo unlockAchievementMethod = null; static MethodInfo isAchievementUnlockedMethod = null;

public static void RegisterAchievement(string modId, string achievementId, string achievementGraphicCode) { if (registerAchievementMethod == null) { Assembly a = GetAchievementsAssembly(); if (a == null) return; Type t = a.GetType("Achievements.AchievementsApi"); registerAchievementMethod = t.GetMethod("RegisterAchievement"); } registerAchievementMethod.Invoke(null, new object[] { modId, achievementId, achievementGraphicCode }); }

public static void UnlockAchievementForPlayer(string achievementId, EntityPlayer player) { if (unlockAchievementMethod == null) { Assembly a = GetAchievementsAssembly(); if (a == null) return; Type t = a.GetType("Achievements.AchievementsApi"); unlockAchievementMethod = t.GetMethod("UnlockAchievementForPlayer"); } unlockAchievementMethod.Invoke(null, new object[] { achievementId, player }); }

public static bool IsAchievementUnlockedForPlayer(string achievementId, EntityPlayer player, bool defaultIfNotInstalled = false) { if (isAchievementUnlockedMethod == null) { Assembly a = GetAchievementsAssembly(); if (a == null) return defaultIfNotInstalled; Type t = a.GetType("Achievements.AchievementsApi"); isAchievementUnlockedMethod = t.GetMethod("IsAchievementUnlockedForPlayer"); } return (bool)isAchievementUnlockedMethod.Invoke(null, new object[] { achievementId, player }); }

Highlights

From source data

Game versions

Supports 7 Vintage Story versions, the newest being 1.18.15.

Footprint

Rated a light load on a server.

Achievements on Nxeon

From our catalogue
One-click install
Supported on Nxeon Vintage Story servers. We download it from Vintage Story ModDB, place it, and restart the server.
Server side
Required on the server
Server load
light
Smallest plan we suggest
Vintage Story — 1 GB (1 GB RAM). This follows our own load rating above, not a benchmark.

Run Achievements on a Vintage Story server

Pick a server or deploy a new one above; it is installed in one click.

What kind of mod it is

From the catalog
Listed on Vintage Story ModDB as “Utility”

Quality of life & UI

Small conveniences, tweaks and interface improvements players notice straight away.

Runs on your server

From source side support

Vintage Story ModDB lists Achievements as required on the server. Check its Vintage Story ModDB page to see whether players need it too.

Compatibility

Game
Vintage Story
Runs on
Serverrequired on the server
Game versions
1.18.15 and 6 earlier

Verified at the source

  • ✓Vintage Story ModDBOfficial listing, checked 2026-09-24
  • ✓AuthorNateonus, as published on Vintage Story ModDB
  • ✓LicenseNot published by the sourceFree

Achievements, answered

Generated from the mod’s own source data.

Do my players need to install Achievements?

Vintage Story ModDB lists Achievements as required on the server. Check its Vintage Story ModDB page to see whether players need it too.

Is it free?

Yes. Achievements is free to download from Vintage Story ModDB.

How do I add it to my Nxeon server?

Use “Add to a server” on this page, or open NxLabs from your dashboard. We install it, restart your server and switch it on.

NxLabs

Run Achievements on a Vintage Story server.

Deploy in about a minute from $4.00 a month, then add Achievements in one click.