mirror of
https://github.com/pmret/papermario.git
synced 2024-09-08 02:29:49 +02:00
Remove outdated / unused tools and such from the repo (#1093)
* Remove outdated / unused tools and such from the repo * Remove shtuff from SETUP.md
This commit is contained in:
Ethan Roseman
GitHub
parent
d516801b5f
commit
53fac51608
25
.github/workflows/docs.yaml
vendored
25
.github/workflows/docs.yaml
vendored
@ -1,25 +0,0 @@
|
||||
name: Doxygen
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
paths:
|
||||
- 'src/*'
|
||||
- 'include/*'
|
||||
- 'docs/*'
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
name: Build and deploy documentation
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v2
|
||||
|
||||
- name: Build
|
||||
uses: mattnotmitt/doxygen-action@v1
|
||||
|
||||
- name: Deploy
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
publish_dir: ./docs/doxygen
|
||||
13
Dockerfile
13
Dockerfile
@ -1,13 +0,0 @@
|
||||
FROM ubuntu:20.04 as build
|
||||
|
||||
ENV DEBIAN_FRONTEND=noninteractive
|
||||
|
||||
COPY requirements.txt /
|
||||
COPY requirements_extra.txt /
|
||||
COPY install_deps.sh /
|
||||
COPY install_compilers.sh /
|
||||
|
||||
RUN apt-get update && ./install_deps.sh --extra && ./install_compilers.sh
|
||||
|
||||
RUN mkdir /papermario
|
||||
WORKDIR /papermario
|
||||
112
Doxyfile
112
Doxyfile
@ -1,112 +0,0 @@
|
||||
# https://www.doxygen.nl/manual/config.html
|
||||
|
||||
PROJECT_NAME = "Paper Mario"
|
||||
PROJECT_NUMBER =
|
||||
PROJECT_BRIEF = "Decompilation of Paper Mario"
|
||||
PROJECT_LOGO =
|
||||
|
||||
OUTPUT_DIRECTORY = docs
|
||||
CREATE_SUBDIRS = NO
|
||||
ALLOW_UNICODE_NAMES = YES
|
||||
|
||||
OPTIMIZE_OUTPUT_FOR_C = YES
|
||||
|
||||
TYPEDEF_HIDES_STRUCT = YES
|
||||
|
||||
NUM_PROC_THREADS = 0
|
||||
|
||||
EXTRACT_ALL = YES
|
||||
EXTRACT_STATIC = YES
|
||||
HIDE_UNDOC_CLASSES = NO
|
||||
HIDE_IN_BODY_DOCS = YES
|
||||
SHOW_GROUPED_MEMB_INC = YES
|
||||
|
||||
FORCE_LOCAL_INCLUDES = YES
|
||||
INLINE_INFO = YES
|
||||
|
||||
SORT_MEMBER_DOCS = NO
|
||||
SORT_BRIEF_DOCS = NO
|
||||
SORT_GROUP_NAMES = NO
|
||||
|
||||
GENERATE_TODOLIST = NO
|
||||
GENERATE_TESTLIST = NO
|
||||
GENERATE_BUGLIST = YES
|
||||
GENERATE_DEPRECATEDLIST= NO
|
||||
|
||||
DISABLE_INDEX = YES
|
||||
GENERATE_TREEVIEW = YES
|
||||
|
||||
ENABLED_SECTIONS =
|
||||
MAX_INITIALIZER_LINES = 1
|
||||
|
||||
SHOW_INCLUDE_FILES = NO
|
||||
SHOW_USED_FILES = YES
|
||||
SHOW_FILES = YES
|
||||
SHOW_NAMESPACES = NO
|
||||
|
||||
QUIET = NO
|
||||
WARNINGS = YES
|
||||
WARN_IF_UNDOCUMENTED = NO
|
||||
WARN_IF_DOC_ERROR = YES
|
||||
WARN_NO_PARAMDOC = NO
|
||||
WARN_AS_ERROR = YES
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
WARN_LOGFILE =
|
||||
|
||||
INPUT = README.md src include
|
||||
FILE_PATTERNS = *.c *.h
|
||||
RECURSIVE = YES
|
||||
EXCLUDE = include/nu include/PR include/ultra64.h
|
||||
EXCLUDE_SYMLINKS = NO
|
||||
EXCLUDE_PATTERNS =
|
||||
EXCLUDE_SYMBOLS =
|
||||
|
||||
USE_MDFILE_AS_MAINPAGE = README.md
|
||||
|
||||
SOURCE_BROWSER = YES
|
||||
INLINE_SOURCES = NO
|
||||
STRIP_CODE_COMMENTS = YES
|
||||
REFERENCED_BY_RELATION = YES
|
||||
REFERENCES_RELATION = NO
|
||||
REFERENCES_LINK_SOURCE = NO
|
||||
SOURCE_TOOLTIPS = YES
|
||||
USE_HTAGS = NO
|
||||
VERBATIM_HEADERS = NO
|
||||
|
||||
ALPHABETICAL_INDEX = NO
|
||||
COLS_IN_ALPHA_INDEX = 5
|
||||
IGNORE_PREFIX =
|
||||
|
||||
GENERATE_HTML = YES
|
||||
HTML_OUTPUT = doxygen
|
||||
HTML_HEADER = docs/doxygen_header.html
|
||||
HTML_FOOTER =
|
||||
HTML_EXTRA_STYLESHEET = docs/doxygen_custom.css
|
||||
HTML_EXTRA_FILES =
|
||||
HTML_COLORSTYLE_HUE = 220
|
||||
HTML_COLORSTYLE_SAT = 100
|
||||
HTML_COLORSTYLE_GAMMA = 80
|
||||
HTML_TIMESTAMP = YES
|
||||
HTML_DYNAMIC_MENUS = YES
|
||||
HTML_DYNAMIC_SECTIONS = YES
|
||||
HTML_INDEX_NUM_ENTRIES = 100
|
||||
HTML_FORMULA_FORMAT = svg
|
||||
|
||||
USE_MATHJAX = YES
|
||||
MATHJAX_FORMAT = SVG
|
||||
|
||||
SEARCHENGINE = YES
|
||||
SERVER_BASED_SEARCH = NO
|
||||
|
||||
GENERATE_LATEX = NO
|
||||
|
||||
ENABLE_PREPROCESSING = YES
|
||||
MACRO_EXPANSION = YES
|
||||
EXPAND_ONLY_PREDEF = YES
|
||||
PREDEFINED = DOXYGEN NON_MATCHING __attribute__((x))=
|
||||
EXPAND_AS_DEFINED = INCLUDE_ASM UNK_TYPE UNK_PTR UNK_RET UNK_FUN_ARG UNK_FUN_PTR UNK_ARGS M
|
||||
SKIP_FUNCTION_MACROS = YES
|
||||
|
||||
SEARCH_INCLUDES = YES
|
||||
INCLUDE_PATH = include include/PR src
|
||||
INCLUDE_FILE_PATTERNS =
|
||||
23
SETUP.md
23
SETUP.md
@ -5,8 +5,6 @@ This repository supports:
|
||||
- [Linux](#unix)
|
||||
- [macOS](#unix)
|
||||
- [Windows Subsystem for Linux 2](#wsl-2)
|
||||
- [Docker](#docker) (any host OS)
|
||||
- [Nix](#nix)
|
||||
|
||||
If you encounter any issues setting up the repo, please feel free to [reach out to us on Discord](https://discord.gg/urUm3VG).
|
||||
|
||||
@ -55,27 +53,6 @@ If you have Visual Studio Code, you can type `code .` to open the repo within it
|
||||
`Ctrl + J` opens up a Linux terminal within VS Code.
|
||||
|
||||
|
||||
## Docker
|
||||
|
||||
A Docker image containing all dependencies can be built and ran as follows:
|
||||
```sh
|
||||
docker build . -t pm
|
||||
docker run --rm -ti -v $(pwd):/papermario pm
|
||||
```
|
||||
|
||||
Then continue with [building](#building)
|
||||
|
||||
## Nix
|
||||
|
||||
Install [Nix](https://nixos.org/download.html) and run `nix-shell`. You will need to set the `NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM` environment variable to `1` (required for cross compiling).
|
||||
|
||||
```sh
|
||||
export NIXPKGS_ALLOW_UNSUPPORTED_SYSTEM=1
|
||||
nix-shell
|
||||
```
|
||||
|
||||
Like the instructions for Docker, continue with [building](#building)
|
||||
|
||||
# Building
|
||||
|
||||
Copy baseroms into the following places (at least 1 is required):
|
||||
|
||||
@ -1,11 +0,0 @@
|
||||
version: "3"
|
||||
services:
|
||||
pm:
|
||||
volumes:
|
||||
- pm-sync:/pm:nocopy
|
||||
image: "pm:latest"
|
||||
tty: true
|
||||
|
||||
volumes:
|
||||
pm-sync:
|
||||
external: true
|
||||
@ -1,151 +0,0 @@
|
||||
/* typography */
|
||||
|
||||
body, table, div, p, dl { font: inherit }
|
||||
|
||||
body, table, div, p, dl, p.reference, p.definition, .memberdecls .header, .mdescRight {
|
||||
color: #121212;
|
||||
font-family: -apple-system, BlinkMacSystemFont, Segoe UI, Helvetica, Arial, sans-serif, Apple Color Emoji, Segoe UI Emoji;
|
||||
}
|
||||
|
||||
:root { font-size: 10px } /* rem multiplier */
|
||||
h1 { font-size: 3rem; }
|
||||
h2 { font-size: 2.25rem; }
|
||||
h3 { font-size: 1.5rem; }
|
||||
h4 { font-size: 1.25rem; }
|
||||
h5 { font-size: 1rem; }
|
||||
h6 { font-size: .875rem; }
|
||||
h1, h2, h3, h4, h5, h6 { margin-bottom: 3px }
|
||||
h1 { border-bottom: 1px solid #eee }
|
||||
|
||||
.contents a:any-link { color: #357edd }
|
||||
.contents a.visited { color: #5e2ca5 }
|
||||
|
||||
p.reference, p.definition { color: #959da5; font-weight: normal; font-size: 11px; line-height: 1.2 }
|
||||
p.reference a, p.definition a { color: #959da5 !important }
|
||||
p.reference a:hover, p.definition a:hover { color: #357edd }
|
||||
|
||||
.memname, .fragment, .memberdecls, .fragment .line, code {
|
||||
font-family: SFMono-Regular, Consolas, Liberation Mono, Menlo, monospace;
|
||||
}
|
||||
|
||||
#PageDoc, .content, p {
|
||||
font-size: 16px;
|
||||
line-height: 1.5;
|
||||
color: #1b1f23;
|
||||
}
|
||||
|
||||
hr {
|
||||
border-color: #eee;
|
||||
margin: 2em;
|
||||
}
|
||||
|
||||
/* layout */
|
||||
|
||||
html { height: 100% }
|
||||
|
||||
body {
|
||||
display: flex;
|
||||
flex-direction: row;
|
||||
|
||||
width: 100%;
|
||||
max-width: 1100px;
|
||||
min-height: 100%;
|
||||
margin: 0 auto;
|
||||
}
|
||||
|
||||
#side-nav {
|
||||
position: relative;
|
||||
width: 250px !important;
|
||||
}
|
||||
|
||||
.ui-resizable-handle, #nav-sync { display: none !important }
|
||||
|
||||
#doc-content {
|
||||
margin-left: 0 !important;
|
||||
flex: 1;
|
||||
}
|
||||
|
||||
#nav-path { display: none } /* hide footer */
|
||||
#MathJax_Message { display: none } /* hide "MathJax loading..." message */
|
||||
|
||||
#MSearchBox {
|
||||
position: fixed;
|
||||
top: 1em;
|
||||
right: 1em;
|
||||
}
|
||||
|
||||
.contents {
|
||||
font-size: 16px;
|
||||
padding-top: 1em;
|
||||
padding-bottom: 2em;
|
||||
}
|
||||
|
||||
/*
|
||||
table {
|
||||
table-layout: fixed;
|
||||
width: 100%;
|
||||
}
|
||||
.memItemLeft { width: 32ch }
|
||||
*/
|
||||
|
||||
/* cleaning */
|
||||
|
||||
#details + .groupheader,
|
||||
.definition,
|
||||
.memtitle { display: none }
|
||||
|
||||
table.memname * {
|
||||
display: inline;
|
||||
}
|
||||
|
||||
/* candy */
|
||||
|
||||
div.fragment, .memproto {
|
||||
padding: 16px;
|
||||
border: 0;
|
||||
border-radius: 6px;
|
||||
background: #f6f8fa;
|
||||
}
|
||||
|
||||
div.fragment div.line {
|
||||
font-size: 85%;
|
||||
line-height: 1.45;
|
||||
}
|
||||
|
||||
code {
|
||||
padding: .2em .4em;
|
||||
margin: 0;
|
||||
font-size: 85%;
|
||||
background: #f6f8fa;
|
||||
}
|
||||
|
||||
.memitem {
|
||||
display: block !important;
|
||||
border-left: 1px solid #eee;
|
||||
padding-left: 1em;
|
||||
margin: 1.5em 0;
|
||||
width: 100%;
|
||||
box-sizing: border-box;
|
||||
}
|
||||
|
||||
.memproto {
|
||||
padding: 8px;
|
||||
box-shadow: none;
|
||||
text-shadow: none;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.memdoc p:first-child {
|
||||
margin-top: 0;
|
||||
}
|
||||
|
||||
.memname {
|
||||
margin-left: 0;
|
||||
}
|
||||
|
||||
.memdoc {
|
||||
border: 0;
|
||||
padding: 0;
|
||||
box-shadow: none;
|
||||
background: none;
|
||||
}
|
||||
@ -1,22 +0,0 @@
|
||||
<!doctype html>
|
||||
<html lang='en'> <!-- closed by doxygen-->
|
||||
<head>
|
||||
<meta charset='utf-8'>
|
||||
<meta name='generator' content='Doxygen $doxygenversion'>
|
||||
<meta name='viewport' content='width=device-width, initial-scale=1'>
|
||||
|
||||
<!--BEGIN PROJECT_NAME--><title>$title - $projectname Documentation</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||
<script type="text/javascript" src="$relpath^dynsections.js"></script>
|
||||
$treeview
|
||||
$search
|
||||
$mathjax
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
|
||||
<body> <!-- closed by doxygen-->
|
||||
<div> <!-- closed by doxygen-->
|
||||
$searchbox
|
||||
77
shell.nix
77
shell.nix
@ -1,77 +0,0 @@
|
||||
{ pkgsNative ? import <nixpkgs> { }
|
||||
, pkgsCross ? import <nixpkgs> { crossSystem = { config = "mips-linux-gnu"; }; }
|
||||
}:
|
||||
|
||||
let
|
||||
mach-nix = import (builtins.fetchGit {
|
||||
url = "https://github.com/DavHau/mach-nix";
|
||||
ref = "master";
|
||||
rev = "8d903072c7b5426d90bc42a008242c76590af916";
|
||||
}) { };
|
||||
|
||||
mach-nix-python = mach-nix.mkPython {
|
||||
requirements = ''
|
||||
${builtins.readFile ./requirements.txt}
|
||||
${builtins.readFile ./requirements_extra.txt}
|
||||
'';
|
||||
};
|
||||
|
||||
gcc-papermario = builtins.fetchurl {
|
||||
url =
|
||||
"https://github.com/pmret/gcc-papermario/releases/download/master/linux.tar.gz";
|
||||
sha256 = "1156cf0d6a88a64c20e2a10fc9445d99cb9a38518f432b1669528dfa82ebb45f";
|
||||
};
|
||||
|
||||
binutils-papermario = builtins.fetchurl {
|
||||
url =
|
||||
"https://github.com/pmret/binutils-papermario/releases/download/master/linux.tar.gz";
|
||||
sha256 = "c3cd88db47ac41f78b557042c7e7ad47ac9c04cee6f0d1069a489c1c9e8c103c";
|
||||
};
|
||||
|
||||
gcc-papermario-272 = builtins.fetchurl {
|
||||
url =
|
||||
"https://github.com/decompals/mips-gcc-2.7.2/releases/download/main/gcc-2.7.2-linux.tar.gz";
|
||||
sha256 = "ff3e299c1d952c0a5cb39f7790a208d0c547cf93986eb5607f820c935cedc288";
|
||||
};
|
||||
|
||||
binutils-papermario-272 = builtins.fetchurl {
|
||||
url =
|
||||
"https://github.com/decompals/mips-binutils-2.6/releases/download/main/binutils-2.6-linux.tar.gz";
|
||||
sha256 = "405a7ddb29a0b2eb472b167e8f15472223df1eff3093a5ff31d6e545d3a6c670";
|
||||
};
|
||||
|
||||
ido = builtins.fetchurl {
|
||||
url =
|
||||
"https://github.com/decompals/ido-static-recomp/releases/download/v0.2/ido-5.3-recomp-ubuntu-latest.tar.gz";
|
||||
sha256 = "65b42b9673b6f439e45e5dafab1eca4fc006a68cda87bdb55681f027d9fb903c";
|
||||
};
|
||||
in pkgsCross.mkShell {
|
||||
nativeBuildInputs = (with pkgsNative; [
|
||||
ninja
|
||||
zlib
|
||||
libyaml
|
||||
patchelf
|
||||
glibc
|
||||
gcc
|
||||
mach-nix-python
|
||||
]);
|
||||
buildInputs = (with pkgsCross; [ gcc binutils ]);
|
||||
|
||||
# This is a very un-Nix-y way of doing things
|
||||
shellHook = ''
|
||||
tar zx -C tools/build/cc/gcc -f ${gcc-papermario}
|
||||
tar zx -C tools/build/cc/gcc -f ${binutils-papermario}
|
||||
|
||||
tar zx -C tools/build/cc/gcc2.7.2 -f ${gcc-papermario-272}
|
||||
tar zx -C tools/build/cc/gcc2.7.2 -f ${binutils-papermario-272}
|
||||
|
||||
tar zx -C tools/build/cc/ido5.3 -f ${ido}
|
||||
|
||||
for dir in $(find tools/build/cc -type d); do
|
||||
for f in $(find $dir -type f); do
|
||||
# Silence errors instead of thinking hard about this
|
||||
${pkgsNative.patchelf}/bin/patchelf --set-interpreter "${pkgsNative.glibc}/lib/ld-linux-x86-64.so.2" $f 2>/dev/null
|
||||
done
|
||||
done
|
||||
'';
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user