From eb03022da69451da9c97a4cb4d1482d16a939e4a Mon Sep 17 00:00:00 2001 From: CCHyper <73803386+CCHyper@users.noreply.github.com> Date: Fri, 21 Jan 2022 22:34:25 +0000 Subject: [PATCH] Updates the readme with a nightly download link. --- README.md | 64 ++++++++++++++++++++++++++++++++++++------------------- 1 file changed, 42 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index ad32f356c..6ea68c17f 100644 --- a/README.md +++ b/README.md @@ -5,19 +5,17 @@ Vinifera is an open-source community collaboration project extending the Tiberian Sun engine.

- GitHub Workflow Status (develop) - GitHub -
- Latest Nightly Build: Download + GitHub Workflow Status (develop) GitHub Workflow Status (develop) + GitHub

# Table of Contents - [Intro](#intro) - [Community](#community) +- [Downloading Vinifera](#downloading-vinifera) +- [Installing Tiberian Sun](#installing-tiberian-sun) +- [Building Vinifera](#building-vinifera) - [Contributing](#contributing) -- [Building The Project](#building-the-project) -- [Installing The Game](#installing-the-game) -- [Running The Game](#running-the-game) - [Third Party Libraries](#third-party-libraries) - [Anti-virus Warning](#anti-virus-warning) - [Legal](#legal) @@ -26,25 +24,27 @@ # Intro Vinifera is an open source community project which aims to provide new features and bug-fixes fixes for Tiberian Sun. + # Community -You can discuss the development and progress of this project on the **C&C Modding Haven** [Discord server]() at the **#vinifera-chat** channel. +You can discuss the development and progress of this project on the **C&C Modding Haven** [Discord server]() at the **`#vinifera-chat`** channel. -# Contributing -If you are interested in contributing to this project, you will need some knowledge of C++ as a minimum requirement, but it is recommended you have experience with binary analysis and x86 assembly. All contributions towards the projects goals are welcome, provided they follow the contribution guidelines. Please join the Discord server to discuss these guidelines with the active developers. Any pull requests that do not fit within the project guidelines will be recommended to be developed as a downstream project. -# Building The Project -This project uses [CMake]() (version 3.17 minimum) for its build system. You can use either CMake via the command line or using the CMake GUI. +# Downloading Vinifera +### Nightly +Every day, an automated build of the `develop` branch is uploaded. These builds contain all the latest merged features, but are not yet considered stable for release. These builds are to help provide an insight to what the next release will contain and should only be used for active playtesting purposes **only**. -The following components are needed to build this project: +There are two version of the Nightly builds available; **"Standard"** and **"Comptability"**. The **Standard** build is _as-is_, where as the **Comptability** build has modifications to ensure compatability _(where possible)_ with existing community patches. If you are unsure which version is best for you, you can ask a developer on the **Discord** server. +You can find the latest Nightly builds [here]() -- Microsoft Visual Studio 2019 for Windows -- MSVC v141 C++ x86/x64 build tools -- Windows 10 SDK +### Release +All release builds are made from the `master` branch. Vinifera is currently working towards its first release so there are no releases available yet, but they will be uploaded to [here](). + +### Installing Vinifera +Download your desired version. Once the desired download is finished, extract the contents of the archive into to the Tiberian Sun directory. Run `LaunchVinifera.exe` to start the game with the Vinifera extension applied. -**PLEASE NOTE:** If you are using the CMake GUI, please make sure to set the output build directory to either outside the source tree or the `./build/` in the source tree root. This directory is ignored for your convenience in the main projects `.gitignore` file. -# Installing The Game -**Instructions for downloading and installing the games if you do not already own them:**

+# Installing Tiberian Sun +**NOTE: If you already have Tiberian Sun installed, you can skip this step;**

Tiberian Sun
Tiberian Sun was released as freeware by Electronic Arts in 2010 as a part of a promotional build-up to the release of Command & Conquer 4: Tiberian Twilight. @@ -57,15 +57,32 @@ Below are direct links to the released disk images *(English (US) only)*;
Otherwise, you can also purchase Tiberian Sun as part of the [Command & Conquer Ultimate Collection]() on EA's Origin service. -**Updating the game to the latest version:** +### Updating the game to the latest version This project currently only supports the latest English (US) version of Tiberian Sun due to technical limitations with patching the original binary.
`GAME.EXE; v2.03[EN]; Monday 5th June, 2000 (21:26:42)`
`MD5: C2C58CBBF83AF0458DC44EF64A3C011F`
You can download the v2.03 patch in English, French, German and Spanish.
**Patch 2.03**: [Download]().
-# Running The Game -Copy the built executables from the build directory to the Tiberian Sun directory. Run `LaunchVinifera.exe` to start the game with the Vinifera project applied. For more information on how to use Vinifera, please read the documention or you can join the **C&C Modding Haven** [Discord server]() and use the **#vinifera-chat** channel. + +# Building Vinifera +**NOTE: This section is only for people who wish to build the source code locally;**

+This project uses [CMake]() (version 3.17 minimum) for its build system. You can use either CMake via the command line or using the CMake GUI. + +The following components are needed to build this project: + +- Microsoft Visual Studio 2019 for Windows +- MSVC v141 C++ x86/x64 build tools +- Windows 10 SDK + +**PLEASE NOTE:** If you are using the CMake GUI, please make sure to set the output build directory to either outside the source tree or the `./build/` in the source tree root. This directory is ignored for your convenience in the main projects `.gitignore` file. + +To run the built version, copy the built executables from the build directory to the Tiberian Sun directory. Run `LaunchVinifera.exe` to start the game with the Vinifera project applied. For more information on how to use Vinifera, please read the documention or you can join the **C&C Modding Haven** [Discord server]() and use the **#vinifera-chat** channel. + + +# Contributing +If you are interested in contributing to this project, you will need some knowledge of C++ as a minimum requirement, but it is recommended you have experience with binary analysis and x86 assembly. All contributions towards this projects goals are welcome, provided they follow the contribution guidelines. Please join the **Discord** server to discuss these guidelines with the active developers. Any pull requests that do not fit within the project guidelines will be recommended to be developed as a downstream project. + # Third-Party Libraries Vinifera makes use of third-party libraries to help implement features. Below is a list of libraries used by the project; @@ -73,9 +90,11 @@ Vinifera makes use of third-party libraries to help implement features. Below is - [Image-Resampler](https://github.com/ramenhut/image-resampler) - [XZip](https://www.codeproject.com/Articles/4135/XZip-and-XUnzip-Add-zip-and-or-unzip-to-your-app-w?msg=3792406) + # Anti-virus Warning Anti-virus software like Windows Defender could mark the binaries built from the DLL configuration in this project as a virus. We would like to assure that this is a false-positive and that these is completely safe to use. If you are still unsure about running these binaries on your system, your are welcome to join our Discord server where one of the developers can explain the process used by this project in detail. + # Legal This project is an unofficial open-source community collaboration project for preservation, modding and compatibility purposes. This project has no direct affiliation with Electronic Arts Inc. and/or Command & Conquer. Command & Conquer is an Electronic Arts Inc. brand. All Rights Reserved. @@ -84,6 +103,7 @@ No assets, texts, artwork or other media from the original game(s) is included i *The video game "Command & Conquer: Tiberian Sun" is copyright © 1999 Westwood Studios. All Rights Reserved.
* *Westwood Studios is a trademark or registered trademark of Electronic Arts in the U.S. and/or other countries. All rights reserved.* + # License The source code provided in this repository is licenced under the [GNU General Public License version 3](). Please see the accompanying LICENSE file.