WindowsXPKg/README.md
CONIGUERO 15cbe19006
Refactor/Overhaul (#40)
* major refactor/overhaul
move generation implementation to libumskt/*
decouple CLI/Options (and JSON) from generation implementation
set groundwork for future shared library
use standardized PIDGEN2/PIDGEN3 naming convention
create a Windows Docker file for quick compilation
add Windows resouce file/header so we have an application icon on windows
use icon from @Endermanch (used with permission)
add support for fully-static linux/muslc-based compilation
add support for a dos/windows (i486+) binary using djgpp
add Dockerfile to compile gcc/djgpp/watt32/openssl to provide DOS (DPMI) binaries
add @Endermanch 's Vista+ documentation
update Readme for recent credits

* begin work on C linkage and emscripten buildpath

* Update CMake to include and build Crypto++

* move dllmain.cpp to the correct directory

* add rust port info to README.md

* re-add dropped changes from rebase

* update build config, specify windows XP version number for crypto++

* update dos-djgpp action to use new cmake builder and options

* update dos-djgpp to use UMSKT hosted forks

* update other workflows to include standard header

* remove crypto++ from build config for now

* use the new `shell` parameter in `threeal/cmake-action`
TODO: move to a stable version (v1.3.0) when ready

* use full commit hash because a shortened hash is unsupported

* add the required {0} parameter?

* add openssl 3.1.1 to windows github runners

* ensure linux matrix build compiles on the correct arch

---------

Co-authored-by: Neo <321592+Neo-Desktop@users.noreply.github.com>
2023-07-08 20:08:43 -07:00

97 lines
2.8 KiB
Markdown

# **Universal MS Key Toolkit (UMSKT)**
[![Zulip chat](https://img.shields.io/badge/zulip-join_chat-brightgreen.svg)](https://umskt.zulipchat.com)
[![libera.chat - #mspid](https://img.shields.io/badge/libera.chat-%23mspid-brightgreen)](https://web.libera.chat/gamja/?nick=Guest?#mspid)
[![C/C++ CI (Linux)](https://github.com/UMSKT/UMSKT/actions/workflows/linux.yml/badge.svg)](../../actions/workflows/linux.yml)
[![C/C++ CI (Windows)](https://github.com/UMSKT/UMSKT/actions/workflows/windows.yml/badge.svg)](../../actions/workflows/windows.yml)
### **Plan of Action / ToDo List**
In light of the recent exponential interest in this project I've decided to put updates of this project here:
* [Please see ticket #8 for more information](../../issues/8)
------
### **FAQ**
#### **What does it do?**
* This program is a tool for researching and experimenting with retro Microsoft product licensing, for products released before 2012.
#### **How does it work?**
* [Enderman's XPKeygen Readme explains everything in detail.](https://github.com/Endermanch/XPKeygen)
#### **How do I use it?**
* It all comes down to four simple steps:
### **Usage**
#### 1. Download the latest version of WindowsXPKg
* *(GitHub account required)*
* Download the latest experimental version using the Actions tab ([Windows](../../actions/workflows/windows.yml?query=branch%3Amaster), [Linux](../../actions/workflows/linux.yml?query=branch%3Amaster)).
* *(GitHub account \*not\* required)*
* Download the latest release for your operating system and architecture from [the releases page](../../releases)
* **Note:** Before continuing, please ensure you have both the `xpkey` program and the `keys.json` datum extracted and in the same directory
#### 2. Run `xpkey` to generate a key, or add `--help` to see more options.
#### 3. *(Activation step for `Retail` and `OEM` only)*
* After installation, you will be prompted to activate Windows.
* Select the **telephone activation** method, then, run `xpkey -i <Installation ID>` using the `Installation ID` the activation Wizard provides for you
#### 4. Profit!
------
### Authors
The list of people who have helped to bring the XP generation to where it is now:
* z22
* MSKey
* sk00ter
* diamondggg
* pottzman
* Endermanch
* Neo-Desktop
* WitherOrNot
* TheTank20
* InvoxiPlayGames
* brakmic
(the list will be updated to add more collaborators)
------
### **Development Requirements:**
* `CMake, make, gcc` (`build-essential`)
* `git`
#### Build Steps:
1. `git clone`
2. `cd build/ && cmake ../ && make`
-----
### **Known Ports**
| Language | Author | Repo URL |
|----------|-----------|-------------------------------------------------------|
| Rust | Alex Page | [anpage/umskt-rs](https://github.com/anpage/umskt-rs) |