├── path.png ├── requirements.txt ├── scripts ├── coneshell.dll ├── Coneshell_call.exe ├── build.bat ├── Run.py ├── Constants.py ├── DBCheck.py ├── Sound.py └── Movie.py ├── .gitignore ├── config.json ├── README.md ├── CODE_OF_CONDUCT.md └── LICENSE /path.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MightyZanark/PriconneUtils/HEAD/path.png -------------------------------------------------------------------------------- /requirements.txt: -------------------------------------------------------------------------------- 1 | PyCriCodecs==0.4.8 2 | pyinstaller==5.1 3 | requests==2.26.0 4 | tqdm=4.66.1 5 | -------------------------------------------------------------------------------- /scripts/coneshell.dll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MightyZanark/PriconneUtils/HEAD/scripts/coneshell.dll -------------------------------------------------------------------------------- /scripts/Coneshell_call.exe: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/MightyZanark/PriconneUtils/HEAD/scripts/Coneshell_call.exe -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | __pycache__/ 3 | database/ 4 | movie/ 5 | sound/ 6 | dist/ 7 | build/ 8 | 9 | Test.py 10 | *.spec 11 | Run.exe 12 | PriconneUtils.exe 13 | PriconneUtilsPrivate.exe 14 | *.ico 15 | -------------------------------------------------------------------------------- /scripts/build.bat: -------------------------------------------------------------------------------- 1 | pyinstaller -y --clean ^ 2 | --distpath="." ^ 3 | --onefile ^ 4 | --name=PriconneUtils ^ 5 | --icon=.\testout.ico ^ 6 | .\scripts\Run.py 7 | 8 | :: If you don't have a .ico file, just delete the --icon line 9 | :: If you do have a .ico file, replace .\testout.ico with the path to your .ico file -------------------------------------------------------------------------------- /config.json: -------------------------------------------------------------------------------- 1 | { 2 | "TruthVersion": 10054800, 3 | "hash": "733ff80375672c8f", 4 | "assetmanifest": "http://prd-priconne-redive.akamaized.net/dl/Resources/version/Jpn/AssetBundles/Windows/manifest/manifest_assetmanifest", 5 | "masterdata": "http://prd-priconne-redive.akamaized.net/dl/Resources/version/Jpn/AssetBundles/Windows/manifest/masterdata_assetmanifest", 6 | "movie": "http://prd-priconne-redive.akamaized.net/dl/Resources/version/Jpn/Movie/PC/High/manifest/movie2manifest", 7 | "sound": "http://prd-priconne-redive.akamaized.net/dl/Resources/version/Jpn/Sound/manifest/soundmanifest", 8 | "db": "http://prd-priconne-redive.akamaized.net/dl/pool/AssetBundles" 9 | } 10 | -------------------------------------------------------------------------------- /scripts/Run.py: -------------------------------------------------------------------------------- 1 | import sys 2 | import multiprocessing 3 | from DBCheck import update_db 4 | from Movie import movie 5 | from Sound import sound 6 | 7 | def run_main(): 8 | print("\n---------- Priconne Utilities ----------\n") 9 | print("> DBCheck: Checks if DB is up to date, recommended to do first time") 10 | print("> Movie: Downloads L2D, UB Cutin, or Summon animations depending on what you want") 11 | print("> Sound: Downloads BGMs and converts them from .wav to .m4a to save space") 12 | print("To choose what you want to do, write 1 for 'DBCheck', 2 for 'Movie', or 3 for 'Sound'") 13 | 14 | while True: 15 | print("\nChoose action:") 16 | print("1. DBCheck\n2. Movie\n3. Sound") 17 | ans = input(">> ").lower().strip() 18 | if ans == '1': 19 | print("'DBCheck' option chosen\n") 20 | update_db() 21 | 22 | elif ans == '2': 23 | print("'Movie' option chosen\n") 24 | movie() 25 | 26 | elif ans == '3': 27 | print("'Sound' option chosen\n") 28 | sound() 29 | 30 | else: 31 | print("> INVALID ACTION! <\nCurrently supported actions: 'DBCheck' 'Movie' 'Sound'") 32 | input("Press ENTER to continue\n") 33 | 34 | again = input("Do you want to do another action? (y/N)\n").lower().strip() 35 | if again != 'y' or again[0] != 'y': 36 | break 37 | 38 | input("Press ENTER to exit this window") 39 | 40 | 41 | if __name__ == '__main__': 42 | if sys.platform.startswith('win'): 43 | multiprocessing.freeze_support() 44 | 45 | run_main() 46 | -------------------------------------------------------------------------------- /scripts/Constants.py: -------------------------------------------------------------------------------- 1 | import os 2 | import re 3 | 4 | CUR_DIR = os.getcwd() 5 | 6 | # DBCheck constants 7 | CONFIG_FILE = os.path.join(CUR_DIR, 'config.json') 8 | DB_DIR = os.path.join(CUR_DIR, 'database') 9 | MAX_TEST = 20 10 | TEST_MULTIPLIER = 10 11 | 12 | 13 | # Movie constants 14 | MOVIE_URL = 'http://prd-priconne-redive.akamaized.net/dl/pool/Movie' 15 | MOVIE_DIR = os.path.join(CUR_DIR, 'movie') 16 | MOVIEMANIFEST = os.path.join(DB_DIR, 'movie2manifest') 17 | 18 | L2D_DIR = os.path.join(MOVIE_DIR, 'l2d') 19 | L2D_NAME = re.compile('character_\d+_000002\.usm') 20 | 21 | CUTIN_DIR = os.path.join(MOVIE_DIR, 'cutin') 22 | CUTIN_NAME = re.compile('cutin_\d+\.usm') 23 | 24 | SUMMON_DIR = os.path.join(MOVIE_DIR, 'summon') 25 | SUMMON_NAME = re.compile('character_\d+_000001\.usm') 26 | 27 | EVENT_DIR = os.path.join(MOVIE_DIR, 'event') 28 | EVENT_NAME = re.compile('story_5\d{5}[7-9]0[1-2]\.usm') 29 | 30 | MOVIE_TYPES = { 31 | 'dir': { 32 | 'cutin': CUTIN_DIR, 33 | 'l2d': L2D_DIR, 34 | 'summon': SUMMON_DIR, 35 | 'event': EVENT_DIR 36 | }, 37 | 'name': { 38 | 'cutin': CUTIN_NAME, 39 | 'l2d': L2D_NAME, 40 | 'summon': SUMMON_NAME, 41 | 'event': EVENT_NAME 42 | } 43 | } 44 | 45 | 46 | # Sound constants 47 | SOUND_URL = 'http://prd-priconne-redive.akamaized.net/dl/pool/Sound' 48 | SOUND_DIR = os.path.join(CUR_DIR, 'sound') 49 | SOUNDMANIFEST = os.path.join(DB_DIR, 'soundmanifest') 50 | 51 | BGM_DIR = os.path.join(SOUND_DIR, 'bgm') 52 | BGM_NAME = re.compile('bgm_.+\.(acb||awb)') 53 | 54 | VOICE_DIR = os.path.join(SOUND_DIR, 'voice') 55 | VOICE_NAME = re.compile('vo_.+\.(acb||awb)') 56 | 57 | SOUND_TYPES = { 58 | 'dir': { 59 | 'bgm': BGM_DIR, 60 | 'voice': VOICE_DIR, 61 | }, 62 | 'name': { 63 | 'bgm': BGM_NAME, 64 | 'voice': VOICE_NAME, 65 | } 66 | } -------------------------------------------------------------------------------- /scripts/DBCheck.py: -------------------------------------------------------------------------------- 1 | import os 2 | import json 3 | from typing import Any 4 | 5 | import requests 6 | # from tqdm import tqdm 7 | 8 | import Constants 9 | 10 | def update_db() -> None: 11 | """Updates the db if there is an update""" 12 | 13 | # Checks if database folder exist, if it doesn't then create one 14 | if not os.path.isdir(Constants.DB_DIR): 15 | os.mkdir(Constants.DB_DIR) 16 | 17 | print('Checking for database updates...') 18 | check_update() 19 | 20 | # Downloads the new database alongside manifests 21 | # print('Downloading database and manifests...') 22 | download_manifest('db') 23 | download_manifest('sound') 24 | download_manifest('movie') 25 | print(">> Update completed!") 26 | 27 | 28 | def download_manifest(type: str) -> None: 29 | """Downloads db or manifest files""" 30 | 31 | with open(Constants.CONFIG_FILE, 'r') as f: 32 | data: dict[str, Any] = json.load(f) 33 | t: str = data[type] 34 | hash: str = data["hash"] 35 | manifest_name: str = t.split("/")[-1] 36 | ver = str(data["TruthVersion"]) 37 | 38 | if type == 'db': 39 | print("Downloading database...") 40 | database = requests.get(f'{t}/{hash[:2]}/{hash}').content 41 | with open('master.cdb', 'wb') as cdb: 42 | cdb.write(database) 43 | os.system(f'Coneshell_call.exe -cdb master.cdb "{os.path.join(Constants.DB_DIR, "master.db")}"') 44 | os.remove('master.cdb') 45 | print("> Finished downloading database!\n") 46 | 47 | else: 48 | print(f'Downloading {manifest_name}...') 49 | manifest = requests.get(t.replace('version', ver)).content 50 | with open(os.path.join(Constants.DB_DIR, manifest_name), 'wb') as m: 51 | m.write(manifest) 52 | print(f"> Finished downloading {manifest_name}!\n") 53 | 54 | 55 | def check_update(): 56 | """Checks if there is an update and updates config.json""" 57 | 58 | with open(Constants.CONFIG_FILE, 'r+') as j: 59 | c: dict[str, Any] = json.load(j) 60 | version: int = c["TruthVersion"] 61 | assetmanifest: str = c["assetmanifest"] 62 | i = 1 63 | # pbar = tqdm(total=Constants.MAX_TEST, leave=False) 64 | 65 | # While loop to check for new versions 66 | while i <= Constants.MAX_TEST: 67 | guess = version + (i * Constants.TEST_MULTIPLIER) 68 | r = requests.get(assetmanifest.replace('version', str(guess))) 69 | if r.status_code == 200: 70 | # pbar.close() 71 | print(f'[{guess}] is a valid new version. Checking for more...') 72 | version = guess 73 | i = 1 74 | # pbar = tqdm(total=Constants.MAX_TEST, leave=False) 75 | 76 | else: 77 | i += 1 78 | # pbar.update(1) 79 | # pbar.close() 80 | 81 | # Checks if the TruthVersion is the same as in config.json 82 | if version == c["TruthVersion"]: 83 | print('> Database version is up to date!\n') 84 | 85 | else: 86 | print(f'New version available: [{version}], updating database...') 87 | # Updates config.json 88 | r = requests.get(str(c["masterdata"]).replace('version', str(version))).content 89 | l = str(r).split(',') 90 | hash = l[2] 91 | c["TruthVersion"] = version 92 | c["hash"] = hash 93 | j.seek(0) 94 | json.dump(c, j, indent=1) 95 | 96 | # print('>> Update check completed!\n') 97 | 98 | 99 | if __name__ == '__main__': 100 | update_db() -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Priconne Utils 2 | 3 | Scripts written in Python to get the master database, BGM files, L2D, UB Cutin, etc. from the game Princess Connect! Re: Dive JP Server. Made and compiled in Windows 10, so it might not work as intended on other OSs. 4 | 5 | 6 | ## Requirements 7 | 8 | - Internet Connection (obviously) 9 | - [acb2wavs (for audio files)](https://github.com/hozuki/libcgss) 10 | - [FFmpeg (for video and audio files)](https://ffmpeg.org/download.html) 11 | 12 | 13 | ## How to Use 14 | 15 | 1. Well first of all, install all the requirements, won't work without it. 16 | 2. If you haven't already, add acb2wavs and FFmpeg to PATH in System Variables. If you don't know how to do that then check out the later section. 17 | 3. Don't forget to download the executable from [latest](https://github.com/MightyZanark/PriconneUtils/releases/latest). 18 | 4. If you got everything set up already, then you can double click on `PriconneUtils.exe` to run the program. After running, a window will pop up and there are instructions there as well. 19 | 5. Type the option that you would like to do, upper/lowercases doesn't matter. 20 | 6. After the program runs the option you selected, it will ask you if you want to continue on to another option or to stop. Just write a simple `y` (yes) or `n` (no) as indicated. 21 | 7. And that is it. The L2D, cutin, etc will be saved in a folder created right where the `PriconneUtils.exe` file is, so if you don't want to bother moving the output files elsewhere later, make sure to place the executable where you want it. 22 | 23 | 24 | ## How to Add to PATH (Windows 10) 25 | 26 | 1. Open up the search bar and search for `system variables`, `Edit the system environment variables` should appear so click on it. 27 | 2. A window called `System Properties` should open and you should be in the `Advanced` tab. 28 | 3. At the very bottom, there should be a button called `Environment Variables...`, click that. 29 | 4. Another window called `Environment Variables` should open up. There are 2 section in it, the upper part is the variables for the **CURRENT USER**, while the bottom part is for the **WHOLE SYSTEM** (or ALL USER). You can choose whether you like acb2wavs and FFmpeg to be available to only the **CURRENT USER** or to **ALL USER**. 30 | 5. After you decided which one you want to edit, find the variable called `Path` (not `PATHEXT`), select it, and press `Edit` or double click it. That should open up yet another window. 31 | 6. In that window, there should be all kinds of options like `New`, `Edit`, `Browse`, `Delete`, etc. To add acb2wavs and UsmToolkit to it, press `New`. 32 | 7. Copy and paste the full path of acb2wavs and UsmToolkit, and by full path I meant something like this `D:\libcgss-win-x86-vc14.2-0.3.7.89\bin\x86\Release` (acb2wavs). At the end of it, you should have something along this line 33 | 34 | ![Image of completed path](./path.png) 35 | 36 | If for some reason, while running the script, something like `acb2wavs is not recognized as an internal or external command, operable program or batch file` appears, try adding an ending backlash ("\\") to the path (from `D:\libcgss-win-x86-vc14.2-0.3.7.89\bin\x86\Release` to `D:\libcgss-win-x86-vc14.2-0.3.7.89\bin\x86\Release\`) 37 | 38 | If this still wasn't clear, you can contact me through Discord from [Priconne Unofficial Server](https://discord.gg/priconne), if you're not from the server, chances are I will just ignore your DM/friend req. My username is **mightyzanark**. 39 | 40 | 41 | ## Building 42 | 43 | If you want to modify and build the program yourself, you will need: 44 | - [Python 3.9.6+](https://www.python.org/downloads/) 45 | - Requests 46 | - Pyinstaller 47 | - PyCriCodecs 48 | - tqdm (currently only for DBCheck progress bar) 49 | 50 | You can download and install the libraries by doing this command in your terminal 51 | ``` 52 | pip install -r requirements.txt 53 | ``` 54 | 55 | After installing those, you can just run the `build.bat` file under the scripts folder. 56 | 57 | 58 | ## Acknowledgment 59 | 60 | Main code is highly inspired from [unity-texture-toolkit](https://github.com/esterTion/unity-texture-toolkit) by `esterTion` and all the endpoints used to grab the assets are from that repo as well, so big thanks to `esterTion` for making those available to the public. -------------------------------------------------------------------------------- /scripts/Sound.py: -------------------------------------------------------------------------------- 1 | import os 2 | import re 3 | import shutil 4 | import multiprocessing 5 | from concurrent.futures import ThreadPoolExecutor 6 | 7 | import requests 8 | 9 | import Constants 10 | 11 | def generate_list(snd_name: str, snd_dir: str) -> tuple[list[str], list[str]]: 12 | if not os.path.isdir(snd_dir): 13 | os.makedirs(snd_dir) 14 | 15 | name = [] 16 | hash = [] 17 | 18 | with open(Constants.SOUNDMANIFEST, 'r') as f: 19 | for lines in f: 20 | l = lines.split(',') 21 | n = l[0].split('/')[-1] 22 | h = l[2] 23 | 24 | if re.fullmatch(snd_name, n): 25 | name.append(os.path.join(snd_dir, n)) 26 | hash.append(h) 27 | 28 | return name, hash 29 | 30 | 31 | def download_file(name: str, hash: str): 32 | dirName = os.path.dirname(name) 33 | realFileName = os.path.basename(name) 34 | nameCheck = re.compile(f'{realFileName.split(".")[0]}.+?m4a') 35 | checked = check_file(nameCheck, dirName) 36 | 37 | if not os.path.isfile(name) and checked is False: 38 | print(f'Downloading {name}...') 39 | r = requests.get(f'{Constants.SOUND_URL}/{hash[:2]}/{hash}').content 40 | with open(name, 'wb') as f: 41 | f.write(r) 42 | 43 | else: 44 | print(f'File [{realFileName}] already exists') 45 | 46 | def convert_file(name: str): 47 | dir_name = os.path.dirname(name) 48 | realFilename = os.path.basename(name) 49 | 50 | acbUnpackDir = os.path.join(dir_name, f'_acb_{realFilename}') 51 | acbInternal = os.path.join(acbUnpackDir, 'internal') 52 | acbExternal = os.path.join(acbUnpackDir, 'external') 53 | 54 | nameCheck = re.compile(f'{realFilename.split(".")[0]}.+?m4a') 55 | checked = check_file(nameCheck, dir_name) 56 | 57 | if checked: 58 | # print(f'Name is {checked}') 59 | # print(f'Filename: {realFilename} | Checkfile: {check_file(nameCheck, dir_name)}') 60 | try: 61 | if name.endswith('.acb') and os.path.isfile(name): 62 | os.system(f'acb2wavs "{name}" -b 00000000 -a 0030D9E8 -n') 63 | os.remove(name) 64 | os.remove(f'{name.split(".")[0]}.awb') 65 | 66 | if os.path.isdir(acbInternal): 67 | for waveFile in os.listdir(acbInternal): 68 | m4aFile = f'{waveFile.split(".")[0]}.m4a' 69 | # print(f'Abspath waveFile: {os.path.abspath(waveFile)} | Abspath m4aFile: {os.path.abspath(m4aFile)}') 70 | print(f'Converting {waveFile} to {m4aFile}...') 71 | os.system('ffmpeg -hide_banner -loglevel quiet -y ' 72 | f'-i "{os.path.abspath(os.path.join(acbInternal, waveFile))}" -vbr 5 -movflags faststart ' 73 | f'"{os.path.abspath(os.path.join(dir_name, m4aFile))}"') 74 | 75 | elif os.path.isdir(acbExternal): 76 | for waveFile in os.listdir(acbExternal): 77 | m4aFile = f'{waveFile.split(".")[0]}.m4a' 78 | print(f'Converting {waveFile} to {m4aFile}...') 79 | os.system( 80 | 'ffmpeg -hide_banner -loglevel quiet -y ' 81 | f'-i "{os.path.abspath(os.path.join(acbExternal, waveFile))}" -vbr 5 -movflags faststart ' 82 | f'"{os.path.abspath(os.path.join(dir_name, m4aFile))}"' 83 | ) 84 | 85 | shutil.rmtree(acbUnpackDir) 86 | print(">>> Conversion done!") 87 | 88 | except Exception as e: 89 | print(f"An ERROR occured\n{e}") 90 | 91 | 92 | def check_file(fn: str, fd: str) -> bool: 93 | for file in os.listdir(fd): 94 | a: re.Match = re.search(fn, file) 95 | if a: 96 | return True 97 | 98 | return False 99 | 100 | 101 | def sound() -> None: 102 | if not os.path.isfile(Constants.SOUNDMANIFEST): 103 | print("Please do DBCheck first before using this as the file needed to download stuff in this script is downloaded from DBCheck") 104 | input("Press ENTER to continue") 105 | 106 | else: 107 | snd_type = input("Select sound type: bgm, voice\n") 108 | 109 | try: 110 | snd_name = Constants.SOUND_TYPES['name'][snd_type.strip()] 111 | snd_dir = Constants.SOUND_TYPES['dir'][snd_type.strip()] 112 | name, hash = generate_list(snd_name, snd_dir) 113 | 114 | except KeyError: 115 | print("> INVALID TYPE! <\nCurrent types are only 'bgm' 'voice'\n") 116 | input("Press ENTER to continue") 117 | 118 | else: 119 | with ThreadPoolExecutor() as thread: 120 | thread.map(download_file, name, hash) 121 | thread.shutdown(wait=True) 122 | 123 | with multiprocessing.Pool() as pool: 124 | pool.map(convert_file, name) 125 | pool.terminate() 126 | 127 | finally: 128 | input(">> Download and conversion completed!\nPress ENTER to continue") 129 | 130 | 131 | if __name__ == '__main__': 132 | sound() 133 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement here on `GitHub` 63 | or on `Discord` (**MightyZanark#0138**). 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /scripts/Movie.py: -------------------------------------------------------------------------------- 1 | import os 2 | import re 3 | import sqlite3 4 | import traceback 5 | import subprocess 6 | import multiprocessing 7 | from concurrent.futures import ThreadPoolExecutor 8 | 9 | import requests 10 | import PyCriCodecs as pcc 11 | 12 | import Constants 13 | 14 | 15 | def generate_list(mov_name: str, dir_name: str) -> tuple[list[str], list[str]]: 16 | """ 17 | Generates name and hash list for ThreadPoolExecutor and multiprocessing 18 | """ 19 | 20 | names = [] 21 | hashes = [] 22 | with open(Constants.MOVIEMANIFEST, "r") as m: 23 | for lines in m: 24 | l = lines.split(",") 25 | n = l[0].split("/")[-1] 26 | h = l[2] 27 | 28 | if re.fullmatch(mov_name, n): 29 | names.append(os.path.join(dir_name, n)) 30 | hashes.append(h) 31 | 32 | return names, hashes 33 | 34 | 35 | def get_filename_and_hash(mov_name: re.Pattern, id: str) -> tuple[str] | bool: 36 | """Gets the filename and hash for a specific unit id""" 37 | 38 | with open(Constants.MOVIEMANIFEST, "r") as m: 39 | for lines in m: 40 | l = lines.split(",") 41 | name = l[0].split("/")[-1] 42 | hash = l[1] 43 | 44 | if re.fullmatch(mov_name, name) and id in name: 45 | return name, hash 46 | 47 | return False 48 | 49 | 50 | def download_file(name: str, hash: str) -> None: 51 | """ 52 | Downloads all video files that doesn't exist yet 53 | """ 54 | 55 | if not os.path.isfile(name) and not os.path.isfile(f'{name.split(".")[0]}.mp4'): 56 | print(f'Downloading [{os.path.basename(name)}]...') 57 | r = requests.get(f'{Constants.MOVIE_URL}/{hash[:2]}/{hash}').content 58 | with open(name, "wb") as usm: 59 | usm.write(r) 60 | 61 | 62 | def convert_file(name: str) -> None: 63 | """ 64 | Converts all of the usm files to mp4 files 65 | """ 66 | 67 | try: 68 | name_mp4 = name.split(".")[0] + ".mp4" 69 | if not os.path.isfile(name_mp4): 70 | filenames = extract(name, os.path.dirname(name)) 71 | ffmpeg_combine = "ffmpeg -hide_banner -loglevel quiet -y " 72 | for fname in filenames[1:]: 73 | ffmpeg_combine += f'-i {fname} ' 74 | 75 | ffmpeg_combine += name_mp4 76 | print(f'Converting [{os.path.basename(name)}]...') 77 | subprocess.run(ffmpeg_combine, check=True) 78 | 79 | for file in filenames: 80 | os.remove(file) 81 | 82 | except subprocess.CalledProcessError: 83 | print("FFmpeg not found!") 84 | print("Please install FFmpeg first or make sure its in the PATH variable") 85 | input("Press ENTER to exit") 86 | exit(1) 87 | 88 | except NotImplementedError as nie: 89 | print(nie) 90 | 91 | except Exception: 92 | print(f'An ERROR occured\n{traceback.format_exc()}') 93 | 94 | 95 | def extract(filename: str, dirname: str = "") -> list[str]: 96 | """ 97 | Slightly modified extract() function from PyCriCodecs's usm.py 98 | to accomodate Priconne's USM\n 99 | Returns a list of all filenames inside of the USM 100 | """ 101 | 102 | # Gets a table consisting of video/audio metadata 103 | usm = pcc.USM(filename) 104 | usm.demux() 105 | table = usm.get_metadata()[0]["CRIUSF_DIR_STREAM"] 106 | filenames: list[str] = [] 107 | for obj in table: 108 | fname: str = obj["filename"][1] 109 | 110 | # Taken from PyCriCodecs' usm.py extract() method 111 | # Adjust filenames and/or paths to extract them into the current directory. 112 | if ":\\" in fname: # Absolute paths. 113 | fname = fname.split(":\\", 1)[1] 114 | elif ":/" in fname: # Absolute paths. 115 | fname = fname.split(":/", 1)[1] 116 | elif ":"+os.sep in fname: # Absolute paths. 117 | fname = fname.split(":"+os.sep, 1)[1] 118 | elif ".."+os.sep in fname: # Relative paths. 119 | fname = fname.rsplit(".."+os.sep, 1)[1] 120 | elif "../" in fname: # Relative paths. 121 | fname = fname.rsplit("../", 1)[1] 122 | elif "..\\" in fname: # Relative paths. 123 | fname = fname.rsplit("..\\", 1)[1] 124 | fname = ''.join(x for x in fname if x not in ':?*<>|"') # removes illegal characters. 125 | 126 | fname = os.path.join(dirname, fname) 127 | if fname not in filenames: 128 | filenames.append(fname) 129 | 130 | keys = list(usm.output.keys()) 131 | while (idx := len(filenames[1:])) < len(usm.output.keys()): 132 | fname: str = filenames[0].split(".")[0] 133 | if "SFV" in keys[idx]: 134 | fname += ".avi" 135 | 136 | elif "SFA" in keys[idx]: 137 | fname += ".wav" 138 | 139 | else: 140 | raise NotImplementedError( 141 | f'Unknown type of data: {keys[idx]}\n' 142 | f'Header: {list(usm.output.values())[idx][:4]}' 143 | ) 144 | 145 | filenames.append(fname) 146 | 147 | for i, (k, data) in enumerate(usm.output.items()): 148 | try: 149 | if "SFV" in k: 150 | with open(filenames[i+1], "wb") as out: 151 | out.write(data) 152 | 153 | elif "SFA" in k: 154 | audio = pcc.ADX.decode(data) 155 | with open(filenames[i+1], "wb") as out: 156 | out.write(audio) 157 | 158 | else: 159 | raise NotImplementedError(f'Unknown type of data: {k}\nHeader: {data[:4]}') 160 | 161 | except IndexError: 162 | print( 163 | 'Filenames amount < Expected output items\n' 164 | f'Filenames = {filenames}\n' 165 | f'Expected output = {list(usm.output.keys())}\n' 166 | ) 167 | 168 | return filenames 169 | 170 | 171 | def download_all(mov_name: str, dir_name: str) -> None: 172 | """Downloads all the usm of a movie type and converts them to mp4""" 173 | 174 | names, hashes = generate_list(mov_name, dir_name) 175 | 176 | with ThreadPoolExecutor() as thread: 177 | thread.map(download_file, names, hashes) 178 | thread.shutdown(wait=True) 179 | 180 | with multiprocessing.Pool() as pool: 181 | pool.map(convert_file, names) 182 | pool.terminate() 183 | 184 | 185 | def movie() -> None: 186 | """ 187 | Runs the Movie download and conversion logic 188 | """ 189 | 190 | if not os.path.isfile(Constants.MOVIEMANIFEST): 191 | print( 192 | "Please do DBCheck first before using this " 193 | "as the file needed to download stuff in this script " 194 | "is downloaded from DBCheck" 195 | ) 196 | input("Press ENTER to continue") 197 | return 198 | 199 | print("Select type: (write the number)") 200 | print("1. cutin\n2. l2d\n3. summon\n4. event") 201 | mov_type = input(">> ").lower().strip() 202 | 203 | try: 204 | mov_dict = {"1": "cutin", "2": "l2d", "3": "summon", "4": "event"} 205 | mov_type = mov_dict[mov_type] 206 | dir_name = Constants.MOVIE_TYPES["dir"][mov_type] 207 | mov_name = Constants.MOVIE_TYPES["name"][mov_type] 208 | 209 | except KeyError: 210 | print("> INVALID TYPE! <") 211 | print("Current types are only 'cutin' (1), 'l2d' (2), 'summon' (3), or 'event' (4)\n") 212 | input("Press ENTER to continue") 213 | return 214 | 215 | if not os.path.isdir(dir_name): 216 | os.makedirs(dir_name) 217 | 218 | # if mov_type == 'event': 219 | download_all(mov_name, dir_name) 220 | 221 | # Does not currently work because db is obfuscated 222 | # else: 223 | # select = input(f"Download all {mov_type}? (y/N, default: N)\n").strip().lower() 224 | 225 | # if select and (select == 'y' or select[0] == 'y'): 226 | # download_all(mov_name, dir_name) 227 | 228 | # else: 229 | # con = sqlite3.connect(os.path.join(Constants.DB_DIR, 'master.db')) 230 | # cur = con.cursor() 231 | # query = cur.execute( 232 | # "SELECT unit_name, unit_id " 233 | # "FROM unit_data " 234 | # "WHERE unit_id < 190000 AND move_speed = 450 AND unit_id != 170101" 235 | # ).fetchall() 236 | # names = [q[0].strip() for q in query] 237 | # ids = [q[1] for q in query] 238 | # name_lst = '' 239 | # for idx, name in enumerate(names, 1): 240 | # offset = 15 - len(name) 241 | # name += u'\u3000' * offset 242 | # idx_str = str(idx) + "." 243 | # name_lst += f"{idx_str:<4} {name}" 244 | # print(f"{idx_str:<4} {name}", end='') 245 | # if idx % 3 == 0: 246 | # name_lst += '\n' 247 | # print() 248 | # print() 249 | 250 | # correct = False 251 | # while not correct: 252 | # chara = input("Enter the character number: ").strip() 253 | # names_len = len(names) 254 | # while not chara.isdigit() or int(chara) < 1 or int(chara) > names_len: 255 | # chara = input(f"Invalid number! Please enter a number between 1-{names_len}: ") 256 | 257 | # chara = int(chara)-1 258 | # name = names[chara] 259 | # id = ids[chara] 260 | 261 | # correct = input(f"Is {name} the right character? (y/N, default: y)\n").strip() 262 | # correct = True if correct != 'n' or correct[0] != 'n' else False 263 | 264 | # found = get_filename_and_hash(mov_name, str(id)[:-2]) 265 | # if not found: 266 | # print(f"{name} does not have a {mov_type}") 267 | 268 | # else: 269 | # name, hash = found 270 | # name = os.path.join(dir_name, name) 271 | # download_file(name, hash) 272 | # convert_file(name) 273 | 274 | input(">> Download and conversion completed!\nPress ENTER to continue") 275 | 276 | 277 | if __name__ == "__main__": 278 | movie() -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------