Optifine Utils

A scraper to get a information about and download jar files from optifine.net

Install

npm install optifine-utils

or

yarn add optifine-utils

Quick Start

import { getVersions } from 'optifine-utils';

const version = await getVersions({ minecraftVersion: '1.19.2' })[0];

version.download('./Optifine_1.19.2.jar');

Docs

Types

Version

type Version = {
    optifineVersion: string;
    fileName: string;
    forgeVersion: string;
    minecraftVersion: string;
    published: Date;
    changelogURL: string;
    getDownloadURL: () => Promise<string>;
    download: (path?: string) => Promise<void>;
    install: () => Promise<boolean>;
    runInstaller: () => Promise<boolean>;
};

GetVersionsFilter

type GetVersionsFiler = {
    optifineVersion?: string;
    fileName?: string;
    forgeVersion?: string;
    minecraftVersion?: string;
    published?: Date;
    changelogURL?: string;
};

Methods

getDownloadURL

Get the download URL of a version

getDownloadURL(fileName: string): Promise<String>

getVersions

Get all avaliable versions on the Optifine downloads site

getVersions(filter?: GetVersionsFilter): Promise<Version[]>

downloadVersion

Download a version

downloadVersion(version: Version, path?: string): Promise<void>

installVersion

Install Optifine (with default settings) without opening the installer

installVersion(version: Version): Promise<boolean>

runInstaller

Download and run the Optifine Installer

runInstaller(version: Version): Promise<boolean>

Credits

All Development is by (@teakivy)

Support

For support, Join my discord (dsc.gg/teakivy) and ask for help in #❓︱support