https://github.com/manwithacap/derelictionary

🖥️🚀Unofficial companion app for Duskers operated as a python script in a terminal.
https://github.com/manwithacap/derelictionary

companion-app duskers python python-script python3 terminal-based

Last synced: about 2 months ago
JSON representation

🖥️🚀Unofficial companion app for Duskers operated as a python script in a terminal.

• Host: GitHub
• URL: https://github.com/manwithacap/derelictionary
• Owner: ManWithACap
• Created: 2023-12-06T20:59:03.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-01-14T09:02:24.000Z (12 months ago)
• Last Synced: 2024-01-14T23:02:05.112Z (12 months ago)
• Topics: companion-app, duskers, python, python-script, python3, terminal-based
• Language: Python
• Homepage:
• Size: 43.9 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Welcome to your Derelictionary!

![Derelictionary](https://i.imgur.com/rwFpGtl.png)

### *Your personal all-you-can-eat buffet of data!~*

---

## About

*Derelictionary* is a Python script  run in a terminal. It functions as a database of information on things such as:

> **Trading Posts**


> **Outposts**


> **Stargates**


> **Galaxies**


> **Systems**

Each of these info nodes can be searched through by a variety of methods and keywords. When data is found, it is reported to the user along with any other information about the object that was searched. I'll refer to it as an app from now on even though it's really just more of a script.

This app is developed by only myself with much love for the great game that is Duskers. Down below I'll explain further on how to use the program and provide screenshots of what it looks like. If you would like to help in creating this app, I'd love to put you on the team! Shoot me a message either here or on Discord @ aamorphous.

## Installation

 1. Go to the [releases](https://github.com/ManWithACap/derelictionary/releases) page and choose which type of download you'd like.

    1. If you downloaded the **.exe** form, simply extract it into a folder and then double click on "derelictionary.exe" to run the app.

    2. If you downloaded the **.py** form, first, extract everything to it's own folder.

        1. Then, open up a terminal of your choice (CMD, PowerShell, GitBash, etc.)

        2. Navigate to the folder you extracted *Derelictionary* to (if you don't know how to, read up [here](https://tutorials.codebar.io/command-line/introduction/tutorial.html)).

            1. Once in the correct directory, run it as a Python script by executing `python main.py` (keep in mind, you MUST have [Python](https://www.python.org/downloads/) installed on your machine).

## Usage

Since *Derelictionary* is a **command-based** application, you'll need to follow the prompts on screen like the ones below in order to use it correctly.

There are **3** functions to *Derelicitonary* currently.

> 🟢 **Read Data**


> 🟡 **Write Data**


> 🔴 **Clear Data**

### Following The Prompts

1. ![image a](https://i.imgur.com/4JEXzLD.png)

2. ![image b](https://i.imgur.com/ZXKtjgz.png)

3. ![image c](https://i.imgur.com/vlwwisr.png)

For example, in image #1, you must enter in a number corresponding to the choices listed to you.

If you choose a number, you will proceed onward into the program without problem (see images a & b).

However, if your input is incorrect or isn't included in the choices, you'll be told to try again (seen in image c).

## [GitHub Markdown Cheat Sheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet)