Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Windows Instructions README updates #1085

Closed
8 tasks done
ericoporto opened this issue Jun 14, 2020 · 11 comments
Closed
8 tasks done

Windows Instructions README updates #1085

ericoporto opened this issue Jun 14, 2020 · 11 comments
Assignees
Labels
context: project related to the project and its organization
Milestone

Comments

@ericoporto
Copy link
Member

ericoporto commented Jun 14, 2020

The Windows Instructions in README.md in the Windows/ directory is incomplete.

It misses information on the following topics:

  • the inno installer and how it's built;
  • the usage of project properties or environment variables in Windows to get the project building
  • suggest where to place the libraries in the system
  • remove mentions on how to make the old manual (I think they are not needed anymore)
  • installation of Windows 8.1 SDK from SDK Archive. It used to be possible to install from VS itself but it's not anymore on the most recent VS 2019.
  • not sure if the windows patch is still needed for allegro, is allegro for Windows AGS on 4.4.2 ?
  • simple how to set AGSEditor as Startup project by right clicking on it in Solution Explorer (prevents "A project with an Output Type of Class Library cannot be started directly", because startup project by default is AGS.Controls);
  • You can't actually use the built editor from scratch because it comes without any templates;

Two small suggestions, not needed but nice to have:

  • reorder things so it's easier to get prebuilt libs+irrKlang refferences+env variable+Editor full solution running;
  • erh, maybe add the hack for debugging AGS with Allegro on Windows without suttering VS is a good one (not needed for SDL2);

There may be other things. I can do the PR with updated instructions just thought about first opening an issue to see if there is more things to mention or if I got something wrong.

@ivan-mogilko ivan-mogilko added this to the 3.5.1 milestone Jun 14, 2020
@ivan-mogilko ivan-mogilko added the context: project related to the project and its organization label Jun 14, 2020
@ivan-mogilko ivan-mogilko self-assigned this Jan 9, 2021
@ivan-mogilko
Copy link
Contributor

ivan-mogilko commented Apr 27, 2021

Added paragraph for building installer: 10e26bb

Had to experiment with PowerShell for some time, because some things were not clear at first...

@ericoporto
Copy link
Member Author

I rearranged above as a list of things that can be ticked as done. I reread it and I think the mention of the patch is gone so I ticked it out too. Feel free to mark/remove things.

@ivan-mogilko
Copy link
Contributor

Is the old manual building still mentioned somewhere? I don't see it, but maybe I'm missing something.

@ericoporto
Copy link
Member Author

Nope, it's not, last remains was slashed in 4b51d35

@persn
Copy link
Contributor

persn commented Apr 27, 2021

simple how to set AGSEditor as Startup project by right clicking on it in Solution Explorer (prevents "A project with an Output Type of Class Library cannot be started directly", because startup project by default is AGS.Controls);

We can make this set automatically to AGSEditor by twiddling the order of the appearance in the solution file. It's not obvious behavior in the solution format but it's possible to do. It should be fast and easy to do so I can take a look at it, and then we don't need to document it

@morganwillcock
Copy link
Member

Nope, it's not, last remains was slashed in 4b51d35

The current instructions don't seem quite right as there is no reason that the Powershell script needs admin rights. Possibly it would be blocked by the Powershell execution policy, but that is a separate problem, and it is possible to bypass a restrictive policy by invoking the script in a particular way.

I'll look at changing the instructions.

@ivan-mogilko
Copy link
Contributor

I also realized that the prebuilt libs archive is outdated, it corresponds to AGS 3.4.0 probably; I'll have to reupload it.

@ivan-mogilko
Copy link
Contributor

ivan-mogilko commented Apr 27, 2021

Pushed another change: 83cc2c6

  • removed mention of OpenGL extension headers, as this should be covered by glad headers in our repository.
  • added note about Windows 8.1 SDK for MSVS 2019.
  • explained which enviroment variables to setup and how (link to msvs documentation).
  • mention which projects in solution are creating final output (executable), just in case.
  • link to newer prebuilt libraries

reordered Engine/Editor building instructions a little bit, trying to make reading these paragraph more natural...

@ivan-mogilko
Copy link
Contributor

ivan-mogilko commented Apr 27, 2021

Probably last commit d2d2a02. I don't know what else to mention there.
Tbh, I don't know how to "suggest where to place the libraries in the system", and why does it matter. Usually on Windows you just place them where you like, and then direct MSVS by setting paths in properties, or env vars.

@ericoporto
Copy link
Member Author

OK, I marked things there on the top post accordingly.

@ivan-mogilko
Copy link
Contributor

Seems like resolved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
context: project related to the project and its organization
Projects
None yet
Development

No branches or pull requests

4 participants