Skip to content

Commit 093466a

Browse files
bod09claude
andcommitted
Trim README: remove stale refs, reduce technical detail
- Removed "mining depth" reference (now specific ore only) - Removed ChainDiscoverer reference (deleted class) - Removed Tag System table (technical detail, not user-facing) - Removed Editing Machine Data section (developer docs in code) - Removed "How It Works" internals (too technical for README) - Condensed Attribution & License section - Cleaner, scannable structure focused on what users need Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent ca3a602 commit 093466a

1 file changed

Lines changed: 23 additions & 80 deletions

File tree

README.md

Lines changed: 23 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -4,120 +4,63 @@ A community-built tool for **Ultimate Mining Tycoon** (Roblox) that helps you bu
44

55
**Live Site:** [bod09.github.io/UMT-Factory-Optimizer](https://bod09.github.io/UMT-Factory-Optimizer/)
66

7-
> **For accurate, up-to-date game data, visit the [UMT Wiki](https://umt.miraheze.org/).** This tool uses the wiki as its source of truth. If you find incorrect data here, please help by updating the wiki first - our automated updater will pull the changes in.
7+
> **For accurate, up-to-date game data, visit the [UMT Wiki](https://umt.miraheze.org/).** If you find incorrect data here, please help by updating the wiki first - our automated updater will pull the changes in.
88
99
## Features
1010

1111
### Factory Optimizer
12-
- Automatically discovers the most profitable processing chains for any mining depth or specific ore
12+
- Select any ore and see the most profitable processing chains ranked by profit
1313
- Interactive node-based flow graphs showing every machine, quantity, and connection
1414
- Accounts for all prestige items (Philosopher's Stone, Ore Upgrader, Transmuters, Duplicator, Nano Sifter)
15-
- Handles byproduct chains (stone, dust, gems, ceramics) as part of one unified flow
16-
- Finds optimal duplicator placement and excess item routing
17-
- Supports batch mode (total profit for N ores) and per-ore comparison
18-
- Bar-to-Gem enhancement path with Prismatic Gem Crucible
15+
- Unified flow: byproduct chains (stone, dust, gems, ceramics) integrated into the main chain
16+
- Optimal duplicator placement and excess item routing
17+
- Batch mode for total profit comparison
18+
- "Best Possible" toggle to see what's achievable with all prestige items
1919

2020
### Progression Guide
21-
- Dynamic stage-by-stage factory progression from fresh start to prestige
22-
- Each stage shows the best factory chain at that budget with node graphs
21+
- Stage-by-stage factory progression from fresh start to prestige
22+
- Best factory chain at each budget with node graphs
2323
- Accounts for starting money from prestige upgrades
2424
- Prestige cost table
2525

2626
### Item Database
27-
- Complete database of all machines with inputs, outputs, effects, and costs
28-
- Machine connection map showing compatible chains
27+
- All machines with inputs, outputs, effects, and costs
28+
- Machine connection map
2929
- Ore and gem stats with depth ranges
3030

31-
## How It Works
31+
## Data-Driven
3232

33-
All calculations run from `data/machines.json` - no hardcoded chains. The system:
34-
35-
1. **FlowOptimizer** resolves the best value for every item type using multi-pass iterative convergence
36-
2. **ChainDiscoverer** finds all terminal products and builds complete processing chains
37-
3. **Duplicator testing** evaluates every possible placement for maximum profit
38-
4. **Byproduct evaluation** finds the best destination for every secondary output
39-
5. **Graph visualization** uses topological forward propagation for accurate quantities
33+
All calculations run from `data/machines.json` - no hardcoded chains. The flow optimizer automatically discovers the best processing path for every item type, including byproduct routing and duplicator placement.
4034

4135
### Automated Wiki Updates
4236

43-
A GitHub Action runs weekly (+ manual trigger) to check the [UMT Wiki](https://umt.miraheze.org/) for game changes:
44-
- Fetches machine data via MediaWiki API
45-
- Safely merges: updates wiki fields (name, cost, description) without overwriting custom optimizer data
37+
A GitHub Action checks the [UMT Wiki](https://umt.miraheze.org/) weekly for game changes:
38+
- Updates machine data (name, cost, description) without overwriting optimizer-specific fields
4639
- Creates a PR with a diff report for review
47-
- Detects active game events and their associated machines
40+
- Detects active game events and their machines
4841

4942
## Data Accuracy
5043

51-
This tool derives its game data from the **[UMT Wiki](https://umt.miraheze.org/)**, maintained by the community. If you notice incorrect values:
52-
53-
1. **Check the wiki first** - it may already be updated
54-
2. **Update the wiki** if you have correct info - the wiki helps everyone
55-
3. **Edit `data/machines.json`** in this repo for optimizer-specific fixes
56-
4. **Submit a PR** with your changes
57-
58-
The wiki is the single source of truth for game data. Our automated updater syncs changes weekly.
59-
60-
## Editing Machine Data
61-
62-
To add or fix machines, edit `data/machines.json`:
63-
64-
```json
65-
{
66-
"machine_id": {
67-
"name": "Display Name",
68-
"cost": 1000,
69-
"category": "metalwork",
70-
"inputs": ["bar"],
71-
"outputs": [{ "type": "plate", "chance": 1.0 }],
72-
"byproducts": [{ "type": "stone", "chance": 1.0 }],
73-
"byproductRatio": 0.5,
74-
"effect": "flat|multiply|percent|set|combine|chance",
75-
"value": 20,
76-
"tag": "tag_name"
77-
}
78-
}
79-
```
44+
Game data comes from the **[UMT Wiki](https://umt.miraheze.org/)**. If you notice incorrect values:
8045

81-
Changes to this file automatically update all calculations and graphs.
82-
83-
## Tag System
84-
85-
Tags track item state and prevent exploit loops:
86-
87-
| Tag | Applied By | Removed By | Notes |
88-
|-----|-----------|------------|-------|
89-
| Cleaned | Ore Cleaner | Crusher | +$10 flat bonus |
90-
| Polished | Polisher | Crusher | +$10 flat bonus |
91-
| Smelted | Ore Smelter | - | Prevents re-smelting |
92-
| Tempered | Tempering Forge | Crusher | 2x value |
93-
| Gold_Infused | Philosopher's Stone | Crusher | +25% value |
94-
| Upgraded | Ore Upgrader | Crusher | Upgrades ore tier |
95-
| Sifted | Sifter/Nano Sifter | - | Prevents re-sifting dust |
96-
| Duplicated | Duplicator | - | 2 copies at 50% value |
97-
| Unduplicatable | Duplicator | - | Persists through crusher |
98-
99-
Items inherit all tags from their ingredients when combined. The Crusher removes most tags (except Unduplicatable).
46+
1. **Update the wiki** - it helps everyone and our updater will sync it
47+
2. **Edit `data/machines.json`** for optimizer-specific fixes
48+
3. **Submit a PR** or open an issue
10049

10150
## Tech Stack
10251

10352
Pure HTML/CSS/JavaScript - no build tools, no frameworks, no dependencies. Hosted on GitHub Pages.
10453

10554
## Attribution & License
10655

107-
### Game Data
108-
Game data is sourced from the **[Ultimate Mining Tycoon Wiki](https://umt.miraheze.org/)** and is licensed under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). Thank you to the wiki contributors who maintain accurate game information.
109-
110-
The wiki is hosted on [Miraheze](https://miraheze.org/), a free wiki hosting platform. Consider [donating to Miraheze](https://miraheze.org/donate) to support the wiki infrastructure.
56+
**Game Data:** Sourced from the [UMT Wiki](https://umt.miraheze.org/) under [CC BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/). The wiki is hosted on [Miraheze](https://miraheze.org/) - consider [donating](https://miraheze.org/donate) to support it.
11157

112-
### Code
113-
The optimizer code (algorithms, UI, visualization) is licensed under the [MIT License](LICENSE).
58+
**Code:** [MIT License](LICENSE)
11459

115-
### Game
116-
Ultimate Mining Tycoon is developed by **Innovation Inc** (Rolijok & Madattak). This is a community fan project - not affiliated with or endorsed by the developers.
60+
**Game:** Ultimate Mining Tycoon is developed by Innovation Inc (Rolijok & Madattak). This is a community fan project - not affiliated with the developers.
11761

11862
## Contributing
11963

12064
1. **Help the wiki** - Update [umt.miraheze.org](https://umt.miraheze.org/) with accurate game data
121-
2. **Fix optimizer data** - Edit `data/machines.json` and submit a PR
65+
2. **Fix data** - Edit `data/machines.json` and submit a PR
12266
3. **Report issues** - Open an issue on GitHub
123-
4. **Improve the code** - Fork, fix, and PR

0 commit comments

Comments
 (0)