npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

ddlc-snapshot-installs

v1.0.0

Published

ddlc-snapshot installations management library

Downloads

6

Readme

ddlc-snapshot-installs Build Status XO code style TypeScript

About

ddlc-snapshot installations management library.

Save and restore backups of all the important content DDLC (and it's mods) uses.

Useful when you don't want to miss anything from the game... 🔎

Installation

With npm:

$ npm i -S ddlc-snapshot-installs

or with Yarn:

$ yarn add ddlc-snapshot-installs

Usage

Before you can follow the steps below, you have to require/import it:

With TypeScript:

import installStore from 'ddlc-snapshot-installs';

With Node.js JavaScript:

const installStore = require('ddlc-snapshot-installs');

Base Objects

Installation

Object that represents a DDLC installation in the store.

  • installName: Name of the installation. Type: string
  • installPath: Path to the installation. Type: string
  • installConfigPath: Optional path to the custom RenPy's config path. Type: string

StoreOperationResult

Object that represents the result of a store operation.

  • storeOperation: Type of the operation. Possible values: [add|remove]
  • success: Success flag. Type: boolean
  • msg: Optional message. Type: string

Add DDLC installation

installStore.add(installName: string, installPath: string, installConfigPath?: string): Promise<StoreOperationResult>

Register a new installation in the installation store. This function requires:

  • an installation name, which must be unique among the installation list;
  • the path to the DDLC installation.

Optionally you can specify where to find the RenPy configuration states.

List DDLC installations

installStore.list(): Promise<Installation[]>

Display the list of DDLC installations stored.

Get installation by name

installStore.get(installName: string): Promise<Installation>

Get the Installation object with the specified installname. Promise rejects if the installName is not found in the store.

Check whether installation is in store

installStore.contains(installName: string): Promise<boolean>

Pretty self-explanatory...

Remove a DDLC installation

installStore.remove(installName: string): Promise<StoreOperationResult>

Remove an installation from the store. This function requires:

  • an installation name.